Commit c50af1d2 authored by Jean-Noël Grad's avatar Jean-Noël Grad Committed by Helen Schottenhamml
Browse files

Tutorials and documentation maintenance

parent 7751b2df
......@@ -94,7 +94,7 @@ public:
const cell_idx_t zNeighbor1 = cell_idx_c( floor( z - containingCellCenter[2] ) );
const cell_idx_t zNeighbor2 = zNeighbor1 + cell_idx_t(1);
// define the 8 nearest cells required for the trilienar interpolation
// define the 8 nearest cells required for the trilinear interpolation
// the cell 'ccc' is the one with the smallest x-, y-, and z-indices
Cell ccc( containingCell.x() + xNeighbor1, containingCell.y() + yNeighbor1, containingCell.z() + zNeighbor1 );
Cell hcc( containingCell.x() + xNeighbor2, containingCell.y() + yNeighbor1, containingCell.z() + zNeighbor1 );
......
......@@ -97,8 +97,8 @@ class CurveGatherPackInfo : public GatherPackInfo
/**
* Construction using vector of sample points
*
* @samplePoints Curve definition using a vector of points in R^3.
* The points are expected to be in "world" coordinates
* @param samplePoints Curve definition using a vector of points in R^3.
* The points are expected to be in "world" coordinates
*/
CurveGatherPackInfo( const shared_ptr<StructuredBlockStorage> & bs,
ConstBlockDataID field,
......
......@@ -58,7 +58,7 @@ namespace gather {
* this potentially very expensive operation is done only once in the setup phases
* - a MPI communicator is created for all processes participating in the gather operation (i.e. that packed
* something ), and the amount of data that each process sends is sent to the gathering process
* - subsequent calls of communciate() use that communicator for an MPI_Gatherv operation
* - subsequent calls of communicate() use that communicator for an MPI_Gatherv operation
*
*/
class MPIGatherScheme
......
......@@ -291,7 +291,7 @@ void TriangleMesh::split( vector<TriangleMesh>& meshes ) const
tnode[2]->conns.insert( tnode[1] );
}
// split vertices by trinagle connetions
// split vertices by triangle connections
set< vector< TriangleMeshNode* > > ssnode;
for( auto nit = nodes.begin(); nit != nodes.end(); ++nit )
{
......
......@@ -312,7 +312,7 @@ namespace geometry {
else if ( c == '*' )
state = STATE_MLC0;
else
throw std::runtime_error("Invalid inputsream syntax");
throw std::runtime_error("Invalid inputstream syntax");
break;
case STATE_LC:
......
......@@ -18,7 +18,7 @@
//! \author Christian Godenschwager <christian.godenschwager@fau.de>
//! \brief Declares class StructuredGeometryFileBasicReader that provides a low-level reader for waLBerla geometry files.
//!
//! This reader has no dependencies towards waLberla or even boost so it can be used by external
//! This reader has no dependencies towards waLBerla or even boost so it can be used by external
//! software to read or write geometry files.
//
//======================================================================================================================
......
......@@ -39,7 +39,7 @@ namespace geometry {
* \brief Provides a reader for waLBerla geometry files.
*
* Note that the data is stored in binary form. There is no correction for other binary data
* representations on different architectures (e.g. different Endianess)!
* representations on different architectures (e.g. different endianness)!
* An opened file is automatically closed upon destruction.
*
* \tparam T The underlying datatype that is stored in binary form in the geometry file
......
......@@ -19,7 +19,7 @@
//! \brief Defines class StructuredGeometryFileReader that provides a reader for waLBerla geometry files.
//!
//! Note that the data is stored in binary form. There is no correction for other binary data
//! representations on different architectures (e.g. different Endianess)!
//! representations on different architectures (e.g. different endianness)!
//
//======================================================================================================================
......
......@@ -60,7 +60,7 @@ Vector3<real_t> massEvaluationDomain( const shared_ptr< StructuredBlockStorage >
* \code
* BlockDataID densityId = field::addFieldAdaptor< lbm::Adaptor<LatticeModel_T>::Density >( blocks, pdfFieldId,
* "density adaptor" );
* \code
* \endcode
*
* for creating a density adaptor. The type of this adaptor/field is 'lbm::Adaptor<LatticeModel_T>::Density'.
* An example for using a SharedFunctor that can be used to register the mass evaluation at a time loop might look
......@@ -69,7 +69,7 @@ Vector3<real_t> massEvaluationDomain( const shared_ptr< StructuredBlockStorage >
* \code
* makeSharedFunctor( lbm::makeMassEvaluation< lbm::Adaptor<LatticeModel_T>::Density >( config, blocks,
* uint_t(0), densityId ) )
* \code
* \endcode
*
* Note that for this example the plot and log frequency can be controlled via the configuration file. In this example,
* _all_ cells are processed. If not all of your cells are actually fluid cells, you should use a 'makeMassEvaluation'
......@@ -78,7 +78,7 @@ Vector3<real_t> massEvaluationDomain( const shared_ptr< StructuredBlockStorage >
* \code
* makeSharedFunctor( lbm::makeMassEvaluation< lbm::Adaptor<LatticeModel_T>::Density, FlagField_T >(
config, blocks, uint_t(0), densityId, flagFieldId, fluidFlagUID ) )
* \code
* \endcode
*/
//**********************************************************************************************************************
......
......@@ -259,7 +259,7 @@ inline void Curved< LatticeModel_T, FlagField_T >::treatDirection( const cell_id
WALBERLA_ASSERT( weights_->get( nx, ny, nz ).get() != nullptr );
WALBERLA_ASSERT_LESS( Stencil::invDirIdx(dir), weights_->get( nx, ny, nz )->size() );
// linear multi reflection model without non-equilibirum
// linear multi reflection model without non-equilibrium
const real_t weight = ( *( weights_->get( nx, ny, nz ) ) )[Stencil::invDirIdx( dir )];
......
......@@ -17,7 +17,7 @@
//! \ingroup lbm
//! \author Matthias Markl <matthias.markl@fau.de>
//
// @see Ginzbourg, I. : Generic boundary conditions for lattice Boltzmann models and their application to advection and anisotropic disperion equations
// @see Ginzbourg, I. : Generic boundary conditions for lattice Boltzmann models and their application to advection and anisotropic dispersion equations
// @see Like, L. et. al.: Boundary Conditions for thermal lattice Boltzmann equation method
//
//======================================================================================================================
......
......@@ -47,10 +47,10 @@ namespace lbm {
// VelocityFunctor_T: functor that requires to implement two member functions:
// 1. A member function "void operator()( const real_t t )" that is called once before the boundary treatement with the current time
// 1. A member function "void operator()( const real_t t )" that is called once before the boundary treatment with the current time
// 2. A member function "Vector3< real_t > operator()( const Vector3< real_t > & x, const real_t t )" that is called for every
// boundary link treated by "treatDirection". The arguments are the position 'x' of the boudnary cell in the simulation space and the current time 't'.
// The functon is supposed to return the velocity used by the boundary treatment.
// boundary link treated by "treatDirection". The arguments are the position 'x' of the boundary cell in the simulation space and the current time 't'.
// The function is supposed to return the velocity used by the boundary treatment.
template< typename LatticeModel_T, typename flag_t, typename VelocityFunctor_T, bool AdaptVelocityToExternalForce = false, bool StoreForce = false >
class DynamicUBB : public Boundary<flag_t>
{
......
......@@ -17,7 +17,7 @@
//! \ingroup lbm
//! \author Matthias Markl <matthias.markl@fau.de>
//
// @see Ginzbourg, I. : Generic boundary conditions for lattice Boltzmann models and their application to advection and anisotropic disperion equations
// @see Ginzbourg, I. : Generic boundary conditions for lattice Boltzmann models and their application to advection and anisotropic dispersion equations
// @see Like, L. et. al.: Boundary Conditions for thermal lattice Boltzmann equation method
//
//======================================================================================================================
......
......@@ -98,7 +98,7 @@ WALBERLA_LBM_CELLWISE_SWEEP_STREAM_COLLIDE_HEAD( WALBERLA_LBM_CELLWISE_SWEEP_SPE
this->densityVelocityOut( x, y, z, lm, Vector3<real_t>( velX, velY, velZ ), updated_rho ); // dont really understand what is been done here
// defining the sqaure of velocities
// defining the square of velocities
const real_t velXX = velX * velX;
const real_t velYY = velY * velY;
const real_t velZZ = velZ * velZ;
......@@ -219,7 +219,7 @@ WALBERLA_LBM_CELLWISE_SWEEP_STREAM_COLLIDE_HEAD( WALBERLA_LBM_CELLWISE_SWEEP_SPE
// defining the constants for central moment space
const real_t rho_inv = real_t(1.0) / updated_rho;
// defining the sqaures
// defining the squares
const real_t sqr_k_110 = k_110 * k_110;
const real_t sqr_k_101 = k_101 * k_101;
const real_t sqr_k_011 = k_011 * k_011;
......@@ -348,7 +348,7 @@ WALBERLA_LBM_CELLWISE_SWEEP_STREAM_COLLIDE_HEAD( WALBERLA_LBM_CELLWISE_SWEEP_SPE
const real_t KC_222 = CS_222 + (real_t(4.0) * sqr_KC_111 + KC_200 * KC_022 + KC_020 * KC_202 + KC_002 * KC_220 + real_t(4.0) * (KC_011 * KC_211 + KC_101 * KC_121 + KC_110 * KC_112) + real_t(2.0) * (KC_120 * KC_102 + KC_210 * KC_012 + KC_201 * KC_021)) * rho_inv
- (real_t(16.0) * KC_110 * KC_101 * KC_011 + real_t(4.0) * (KC_020 * sqr_KC_101 + KC_200 * sqr_KC_011 + KC_002 * sqr_KC_110) + real_t(2.0) * KC_200 * KC_020 * KC_002) * sqr_rho_inv;
// trnasform back to central moment space
// transform back to central moment space
// transform from central moment space to distribution funtion
// const defined for velocity in X direction
......@@ -389,7 +389,7 @@ WALBERLA_LBM_CELLWISE_SWEEP_STREAM_COLLIDE_HEAD( WALBERLA_LBM_CELLWISE_SWEEP_SPE
// collision is taking place from here and I need to change it from here
// transform from velocity space to moment space and then to cumulant space , perform collsiopn and then again back transform to velocity space //
// transform from velocity space to moment space and then to cumulant space , perform collision and then again back transform to velocity space //
// const defined for velocity in Y direction
const real_t oneminus_sqr_vely = real_t(1.0) - velYY ;
......@@ -633,7 +633,7 @@ WALBERLA_LBM_CELLWISE_SWEEP_COLLIDE_HEAD( WALBERLA_LBM_CELLWISE_SWEEP_SPECIALIZA
// defining the constants for central moment space
const real_t rho_inv = real_t(1.0) / updated_rho;
// defining the sqaures
// defining the squares
const real_t sqr_k_110 = k_110 * k_110 ;
const real_t sqr_k_101 = k_101 * k_101 ;
const real_t sqr_k_011 = k_011 * k_011 ;
......@@ -765,7 +765,7 @@ WALBERLA_LBM_CELLWISE_SWEEP_COLLIDE_HEAD( WALBERLA_LBM_CELLWISE_SWEEP_SPECIALIZA
const real_t KC_222 = CS_222 + (real_t(4.0) * sqr_KC_111 + KC_200 * KC_022 + KC_020 * KC_202 + KC_002 * KC_220 + real_t(4.0) * (KC_011 * KC_211 + KC_101 * KC_121 + KC_110 * KC_112) + real_t(2.0) * (KC_120 * KC_102 + KC_210 * KC_012 + KC_201 * KC_021)) * rho_inv
- (real_t(16.0) * KC_110 * KC_101 * KC_011 + real_t(4.0) * (KC_020 * sqr_KC_101 + KC_200 * sqr_KC_011 + KC_002 * sqr_KC_110) + real_t(2.0) * KC_200 * KC_020 * KC_002) * sqr_rho_inv;
// trnasform back to central moment space
// transform back to central moment space
// transform from central moment space to distribution funtion
// const defined for velocity in X direction
const real_t oneminus_sqr_velx = real_t(1.0) - velXX ;
......@@ -805,7 +805,7 @@ WALBERLA_LBM_CELLWISE_SWEEP_COLLIDE_HEAD( WALBERLA_LBM_CELLWISE_SWEEP_SPECIALIZA
// collision is taking place from here and I need to change it from here
// transform from velocity space to moment space and then to cumulant space , perform collsiopn and then again back transform to velocity space //
// transform from velocity space to moment space and then to cumulant space , perform collision and then again back transform to velocity space //
// const defined for velocity in Y direction
const real_t oneminus_sqr_vely = real_t(1.0) - velYY ;
......
......@@ -102,7 +102,7 @@ void updateAndSyncInfoCollection(BlockForest& bf, const BlockDataID boundaryHand
bs.setReceiverInfoFromSendBufferState(false, true);
bs.sendAll();
// info collection has to be distirbuted to neighboring processes such that later on when coarsening was applied,
// info collection has to be distributed to neighboring processes such that later on when coarsening was applied,
// the weight of the coarsened block can be computed
for( auto recvIt = bs.begin(); recvIt != bs.end(); ++recvIt )
{
......@@ -203,6 +203,6 @@ private:
};
} // namepace amr
} // namespace amr
} // namespace lbm_mesapd_coupling
} // namespace walberla
......@@ -577,7 +577,7 @@ private:
* also in Dorschner, Chikatamarla, Boesch, Karlin - Grad's approximation for moving and stationary walls in entropic lattice Boltzmann simulations, Journal of Computational Physics, 2015
* omegaShear: relaxation RATE that determines the kinematic viscosity
*
* To obtain the pressure gradient information, finite differences with central differences (useCentralDifferences) are used if enouhg information available, else upwinding differences are applied.
* To obtain the pressure gradient information, finite differences with central differences (useCentralDifferences) are used if enough information available, else upwinding differences are applied.
* When useDataFromGhostLayers = true, a full ghost layer sync is required just before the reconstruction step. This is required to avoid inconsistencies when using parallelization as else the behavior close to block boarders is altered.
*/
template< typename BoundaryHandling_T >
......
......@@ -122,7 +122,7 @@ inline bool EPA::EPA_Triangle::link( size_t edge0, EPA_Triangle* tria, size_t ed
*/
inline void EPA::EPA_Triangle::silhouette( const Vec3& w, EPA_EdgeBuffer& edgeBuffer )
{
//std::cerr << "Starting Silhoutette search on Triangle {" << indices_[0] << "," << indices_[1] << "," << indices_[2] << "}" << std::endl;
//std::cerr << "Starting Silhouette search on Triangle {" << indices_[0] << "," << indices_[1] << "," << indices_[2] << "}" << std::endl;
edgeBuffer.clear();
obsolete_ = true;
......@@ -134,7 +134,7 @@ inline void EPA::EPA_Triangle::silhouette( const Vec3& w, EPA_EdgeBuffer& edgeBu
//*************************************************************************************************
/*! \brief Recursive silhuette finding method.
/*! \brief Recursive silhouette finding method.
*/
void EPA::EPA_Triangle::silhouette( size_t index, const Vec3& w,
EPA_EdgeBuffer& edgeBuffer )
......@@ -221,7 +221,7 @@ bool EPA::doEPAmargin( Support &geom1,
//*************************************************************************************************
/*! \brief Does an epa computation with contact margin added and specified realtive error.
/*! \brief Does an epa computation with contact margin added and specified relative error.
*/
bool EPA::doEPA( Support &geom1,
Support &geom2,
......@@ -233,7 +233,7 @@ bool EPA::doEPA( Support &geom1,
real_t eps_rel )
{
//have in mind that we use a support mapping which blows up the objects a wee bit so
//zero penetraion aka toching contact means that the original bodies have a distance of 2*margin between them
//zero penetration aka touching contact means that the original bodies have a distance of 2*margin between them
//Set references to the results of GJK
size_t numPoints( static_cast<size_t>( gjk.getSimplexSize() ) );
......@@ -521,12 +521,12 @@ inline void EPA::createInitialSimplex( size_t numPoints,
switch(numPoints) {
case 2:
{
//simplex is a line segement
//simplex is a line segment
//add 3 points around the this segment
//the COS is konvex so the resulting hexaheadron should be konvex too
Vec3 d = epaVolume[1] - epaVolume[0];
//find coordinate axis e_i which is furthest from paralell to d
//find coordinate axis e_i which is furthest from parallel to d
//and therefore d has the smallest abs(d[i])
real_t abs0 = std::abs(d[0]);
real_t abs1 = std::abs(d[1]);
......@@ -616,7 +616,7 @@ inline void EPA::createInitialSimplex( size_t numPoints,
const Vec3& A = epaVolume[2]; //The Point last added to the simplex
const Vec3& B = epaVolume[1]; //One Point that was already in the simplex
const Vec3& C = epaVolume[0]; //One Point that was already in the simplex
//ABC is a conterclockwise triangle
//ABC is a counterclockwise triangle
const Vec3 AB = B-A; //The vector A->B
const Vec3 AC = C-A; //The vector A->C
......@@ -719,7 +719,7 @@ inline bool EPA::originInTetrahedron( const Vec3& p0, const Vec3& p1, const Vec3
//*************************************************************************************************
/*! \brief Retrurns true, if the origin lies in the tetrahedron ABCD.
/*! \brief Returns true, if the origin lies in the tetrahedron ABCD.
*/
inline bool EPA::originInTetrahedronVolumeMethod( const Vec3& A, const Vec3& B, const Vec3& C,
const Vec3& D )
......@@ -745,7 +745,7 @@ inline bool EPA::originInTetrahedronVolumeMethod( const Vec3& A, const Vec3& B,
//*************************************************************************************************
/*! \brief Retrurns true, if a point lies in the tetrahedron ABCD.
/*! \brief Returns true, if a point lies in the tetrahedron ABCD.
* \param point The point to be checked for containment.
*/
inline bool EPA::pointInTetrahedron( const Vec3& A, const Vec3& B, const Vec3& C, const Vec3& D,
......@@ -812,7 +812,7 @@ inline bool EPA::searchTetrahedron(Support &geom1,
do{
loopCount++;
pointIndexToRemove = -1;
//Check if opposite tetrahedron point and orign are on the same side
//Check if opposite tetrahedron point and origin are on the same side
//of the face. (for all faces)
Vec3 normal0T = (epaVolume[1] -epaVolume[0]) % (epaVolume[2]-epaVolume[0]);
real_t dot_val = normal0T*epaVolume[0];
......
......@@ -199,7 +199,7 @@ private:
//*************************************************************************************************
/*!\brief Class storing Information about a triangular facette (Triangle) of the EPA-Polytope
*
* see Collision detction in interactiv 3D environments; Gino van den bergen page 155
* see Collision detection in interactive 3D environments; Gino van den bergen page 155
*/
class EPA::EPA_Triangle {
public:
......@@ -392,7 +392,7 @@ inline bool EPA::EPA_Triangle::isClosestInternal() const
//=================================================================================================
//*************************************************************************************************
/*! \brief Calucates a support point of a body extended by threshold.
/*! \brief Calculates a support point of a body extended by threshold.
* Adds this support and the base points at bodies a and b to the vector.
* \param geom The body.
* \param dir The support point direction.
......@@ -424,7 +424,7 @@ inline void EPA::pushSupportMargin(const Support &geom1,
//*************************************************************************************************
/*! \brief Calucates a support point of a body extended by threshold.
/*! \brief Calculates a support point of a body extended by threshold.
* Replaces the old value in the vectors at "IndexToReplace" with this support and the base points at bodies a and b .
* \param geom The body.
* \param dir The support point direction.
......
......@@ -42,7 +42,7 @@ GJK::GJK()
}
/**
* \brief Calucate a support point of a particle extended by threshold.
* \brief Calculate a support point of a particle extended by threshold.
* \param geom support functions for particle 1 and 2.
* \param dir The support point direction.
* \param threshold Extension of the particle.
......@@ -189,7 +189,7 @@ real_t GJK::doGJK(const Support &geom1, const Support &geom2, Vec3& normal, Vec3
* \param geom1 support function for the first particle
* \param geom2 support function for the second particle
* \param margin The margin by which the objects will be enlarged.
* \return true, if an itersection is found.
* \return true, if an intersection is found.
*/
bool GJK::doGJKmargin(const Support &geom1, const Support &geom2, real_t margin)
{
......@@ -305,7 +305,7 @@ bool GJK::doGJKmargin(const Support &geom1, const Support &geom2, real_t margin)
//*************************************************************************************************
/**
* \brief Calculate clostes Point in the simplex and its distance to the origin.
* \brief Calculate closest Point in the simplex and its distance to the origin.
*/
inline real_t GJK::calcDistance( Vec3& normal, Vec3& contactPoint )
{
......@@ -341,7 +341,7 @@ inline real_t GJK::calcDistance( Vec3& normal, Vec3& contactPoint )
//Vec3 ac = -A;
//Vec3 bc = -simplex[1];
//calc baryzenctric coordinats
//calc barycentric coordinates
// compare "Real-Time Collision Detection" by Christer Ericson page 129
//double t = ac*ab;
real_t t = real_t(-1.0) * (A * ab);
......@@ -461,7 +461,7 @@ bool GJK::simplex3(Vec3& d)
const Vec3& A = simplex_[2]; //The Point last added to the simplex
const Vec3& B = simplex_[1]; //One Point that was already in the simplex
const Vec3& C = simplex_[0]; //One Point that was already in the simplex
//ABC is a conterclockwise triangle
//ABC is a counterclockwise triangle
const Vec3 AO = -A; //The vector A->O with 0 the origin
const Vec3& AOt = AO; //The transposed vector A->O with O the origin
......@@ -586,7 +586,7 @@ bool GJK::simplex4(Vec3& d)
{
//the simplex is a tetrahedron
const Vec3& A = simplex_[3]; //The Point last added to the tetrahedron
//t in front mens just a temp varialble
//t in front means just a temp variable
const Vec3& B = simplex_[2]; //One Point that was already in the simplex
const Vec3& C = simplex_[1]; //One Point that was already in the simplex
const Vec3& D = simplex_[0];
......
......@@ -35,7 +35,7 @@ namespace mesa_pd {
namespace collision_detection {
//*************************************************************************************************
/*!\brief Impelementation of the Gilbert-Johnson-Keerthi Algorithm.
/*!\brief Implementation of the Gilbert-Johnson-Keerthi Algorithm.
*/
class GJK
{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment