Commit 25af88f4 authored by Jean-Noël Grad's avatar Jean-Noël Grad
Browse files

Fix 756 Doxygen warnings

Delete Doxygen blocks duplicated in both .h and .cpp files.
Fix incorrect argument names in \param blocks. Fix filenames
in \file blocks. Fix broken Doxygen syntax (broken numerated
lists containing more than 9 items, invalid HTML tags, broken
links in \ref and malformed math equations). Wrap code blocks
inside \code ... \endcode.
parent 26462f8e
......@@ -41,7 +41,7 @@ catch( std::exception & e) { WALBERLA_ABORT( e.what() ); }
/*******************************************************************************************************************//**
* \brief Opens an existing geometry file.
*
* \param filename Name (path) of the file.
* \param _filename Name (path) of the file.
*
* \post isOpen() == true
**********************************************************************************************************************/
......@@ -53,11 +53,11 @@ catch( std::exception & e) { WALBERLA_ABORT( e.what() ); }
/*******************************************************************************************************************//**
* \brief Creates a new geometry file with extends xSize x ySize x zSize.
*
* \param filename Name (path) of the file.
* \param xSize Extend of the geometry file in x direction.
* \param ySize Extend of the geometry file in y direction.
* \param zSize Extend of the geometry file in z direction.
* \param value The value the cells are initialized with. Defaults to T().
* \param _filename Name (path) of the file.
* \param _xSize Extend of the geometry file in x direction.
* \param _ySize Extend of the geometry file in y direction.
* \param _zSize Extend of the geometry file in z direction.
* \param value The value the cells are initialized with. Defaults to T().
*
* \post isOpen() == true
**********************************************************************************************************************/
......@@ -73,12 +73,12 @@ catch( std::exception & e) { WALBERLA_ABORT( e.what() ); }
/*******************************************************************************************************************//**
* \brief Creates a new geometry file with extends xSize x ySize x zSize.
*
* \param filename Name (path) of the file.
* \param xSize Extend of the geometry file in x direction.
* \param ySize Extend of the geometry file in y direction.
* \param zSize Extend of the geometry file in z direction.
* \param values An array of size xSize * ySize * zSize with the values to initialize the
* geometry file with.
* \param _filename Name (path) of the file.
* \param _xSize Extend of the geometry file in x direction.
* \param _ySize Extend of the geometry file in y direction.
* \param _zSize Extend of the geometry file in z direction.
* \param values An array of size xSize * ySize * zSize with the values to initialize the
* geometry file with.
*
* \pre values != nullptr
*
......@@ -96,9 +96,9 @@ catch( std::exception & e) { WALBERLA_ABORT( e.what() ); }
/*******************************************************************************************************************//**
* \brief Opens an existing geometry file.
*
* An already opened file gets closed beforehand.
* An already opened file gets closed beforehand.
*
* \param filename Name (path) of the file.
* \param _filename Name (path) of the file.
*
* \post isOpen() == true
**********************************************************************************************************************/
......@@ -117,11 +117,11 @@ void VoxelFileReader<T>::open( const std::string & _filename )
*
* An already opened file gets closed beforehand.
*
* \param filename Name (path) of the file.
* \param xSize Extend of the geometry file in x direction.
* \param ySize Extend of the geometry file in y direction.
* \param zSize Extend of the geometry file in z direction.
* \param value The value the cells are initialized with. Defaults to T().
* \param _filename Name (path) of the file.
* \param _xSize Extend of the geometry file in x direction.
* \param _ySize Extend of the geometry file in y direction.
* \param _zSize Extend of the geometry file in z direction.
* \param value The value the cells are initialized with. Defaults to T().
*
* \post isOpen() == true
**********************************************************************************************************************/
......@@ -140,12 +140,12 @@ void VoxelFileReader<T>::create( const std::string & _filename, uint_t _xSize, u
*
* An already opened file gets closed beforehand.
*
* \param filename Name (path) of the file.
* \param xSize Extend of the geometry file in x direction.
* \param ySize Extend of the geometry file in y direction.
* \param zSize Extend of the geometry file in z direction.
* \param values An array of size xSize * ySize * zSize with the values to initialize the
* geometry file with.
* \param _filename Name (path) of the file.
* \param _xSize Extend of the geometry file in x direction.
* \param _ySize Extend of the geometry file in y direction.
* \param _zSize Extend of the geometry file in z direction.
* \param values An array of size xSize * ySize * zSize with the values to initialize the
* geometry file with.
*
* \pre values != nullptr
*
......@@ -259,7 +259,7 @@ uint_t VoxelFileReader<T>::zSize() const
*
* \param cellInterval The axis-aligned bounding box of the block of data to be read.
* \param [out] data The vector the read data is stored to. The Storage order is zyx. (Meaning
* your innermost loop should iterate over x)
* your innermost loop should iterate over x)
*
* \pre isOpen() == true
*
......@@ -279,7 +279,7 @@ void VoxelFileReader<T>::read( const CellInterval & cellInterval, std::vector<T>
*
* \param cellInterval The axis-aligned bounding box of the block of data to be written.
* \param data The vector holding the data to bw written to the geometry file. The Storage
* order is zyx. (Meaning your innermost loop should iterate over x)
* order is zyx. (Meaning your innermost loop should iterate over x)
*
* \pre isOpen() == true
* \pre !cellInterval.empty()
......
......@@ -80,7 +80,7 @@ namespace gui {
* Draws data structure represented by this Adaptor to a grid of cells
* Block has to be set first!
*
* @param [inout] grid Grid of cells. Use functions of CellView to draw
* @param [in,out] grid Grid of cells. Use functions of CellView to draw
* The Grid has dimension of innerSize + ghostLayers
* @param [in] nrOfGhostLayers the number of ghost layers in each direction. This value may be bigger
* than the returned value of configure() since other fields might have more ghost layers.
......@@ -92,8 +92,6 @@ namespace gui {
/**
* Optionally adds a QTreeWidgetItem to a tree, containing configuration options
*
* @param parentItem the item where own items can be added
*/
virtual void addConfigurationItem( QTreeWidgetItem * ) {}
......
//======================================================================================================================
/*!
* \file CMakeDefs.h
* \file CMakeDefs.in.h
* \brief Definitions for blockforest module configured by cmake
*/
//======================================================================================================================
......
......@@ -44,7 +44,7 @@ namespace lbm {
/*!
* \brief Class for using the PerformanceEvaluation in a timeloop
*
* Providing a measurement interval, this class will regularly (every <interval> time steps) measure and report the
* Providing a measurement interval, this class will regularly (every \a interval time steps) measure and report the
* LBM performance. At the end of the simulation logOverallResults() may be called to output minimum, maximum and
* average performance during the simulation run.
*/
......
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file DefaultBoundaryHandlingCollectionFactory.h
//! \file DefaultBoundaryHandlingCollection.h
//! \ingroup lbm
//! \author Matthias Markl <matthias.markl@fau.de>
//
......
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file DefaultDiffusionBoundaryHandlingFactory.h
//! \file DefaultDiffusionBoundaryHandling.h
//! \ingroup lbm
//! \author Matthias Markl <matthias.markl@fau.de>
//
......
......@@ -53,11 +53,12 @@ public:
Permeability( real_t viscosity, const BlockDataID & pdfFieldId, const BlockDataID & boundaryHandlingId, const FlagUID & fluid,
const shared_ptr<blockforest::StructuredBlockForest> blocks );
/*!
/*!
* \brief Initializes the permeability evaluation with the parameters given in the config file.
*
* Configuration block:
*
* \code{.unparsed}
* <some_name>
* {
* sampleVolume [<0, 0, 0> , <100, 100, 100>]; [optional, default = domain]
......@@ -65,6 +66,7 @@ public:
* calcFrequency 100; [required, unsigned int]
* convCrit 1E-20; [optional, default = 1E-20]
* }
* \endcode
*
*
* \param config The config block handle containing the parameters.
......
......@@ -53,9 +53,9 @@ real_t intersectionRatioSphere( const geometry::Sphere & sphere,
*
* Let P_i be the intersection point
*
* \param body surface
* \param fluidPoint (P_f), start point of ray
* \param direction (d) of ray (length of d is the length of the ray segment)
* \param policy defines behavior in erroneous cases
* \param epsilon abortion criterion for iterative methods. Epsilon relates to the distance of P_i to the surface
* \return Intersection ratio: | P_i - P_f | / | d |
*/
......
......@@ -36,6 +36,7 @@ namespace initializer {
* \ingroup geometry
*
* Configuration file syntax:
* \code{.unparsed}
* <blockName>
* {
* scenario rect2D|pipe;
......@@ -49,6 +50,7 @@ namespace initializer {
* // the remaining third axis has to be periodic. By default chosen as a non-periodic axis
* // that is not the flowAxis
* }
* \endcode
*
* scenario:
* - rect2D: rectangular channel where boundary in direction of periodicAxis are set periodic
......
......@@ -49,44 +49,44 @@ namespace force_model {
*
* Every force model must implement the following concept:
*
* 1. Every force model must have a "tag". See force_model::None_tag and class force_model::None. If you write your
* 1. Every force model must have a "tag". See force_model::None_tag and class force_model::None. If you write your
* own force model and none of the existing tags fit, just define your own empty struct and use it as tag.
* 2. Every force model must define a type "DirectionIndependentTerms_T" which must be returned by function
* 2. Every force model must define a type "DirectionIndependentTerms_T" which must be returned by function
* "directionIndependentTerms" (see 9) and which is passed to function "forceTerm" (see 10) during the collision
* step. [If your force model does not have or does not need to calculate any common, direction-independent terms,
* you can use the empty struct force_model::NoDirectionIndependentTerms - see class force_model::None as an example]
* 3. static const bool shiftMacVel: specifies whether or not during the evaluation of the macroscopic velocity there
* 3. static const bool shiftMacVel: specifies whether or not during the evaluation of the macroscopic velocity there
* is a shift by F/2
* 4. static const bool shiftEquVel: specifies whether or not during the evaluation of the equilibrium velocity there
* 4. static const bool shiftEquVel: specifies whether or not during the evaluation of the equilibrium velocity there
* is a shift by F/2
* 5. static const bool constant: true, if the body force is constant for all cells throughout the entire simulation
* 5. static const bool constant: true, if the body force is constant for all cells throughout the entire simulation
* (false otherwise)
* 6. void configure( IBlock & block, StructuredBlockStorage & sbs ): this function is called when a force model
* 6. void configure( IBlock & block, StructuredBlockStorage & sbs ): this function is called when a force model
* instance is assigned to a block - can be used to
* scale stored values to a different grid level
* 7. const Vector3<real_t> force() const: must return the body force (this function must only exist if constant == true)
* 8. const Vector3<real_t> force( const cell_idx_t x, const cell_idx_t y, const cell_idx_t z ) const:
* 7. const Vector3<real_t> force() const: must return the body force (this function must only exist if constant == true)
* 8. const Vector3<real_t> force( const cell_idx_t x, const cell_idx_t y, const cell_idx_t z ) const:
* -> must return the force for block local cell (x,y,z) - this function must also exist for constant forces!
* 9. template< typename LatticeModel_T >
* 9. "template< typename LatticeModel_T >
* DirectionIndependentTerms_T directionIndependentTerms( const cell_idx_t x, const cell_idx_t y, const cell_idx_t z,
* const Vector3<real_t> & velocity, const real_t rho,
* const real_t omega ) const:
* const real_t omega ) const":
* -> can be used to pre-calculate common, direction-independent terms that are needed for every lattice direction
* of cell (x,y,z)
* Parameters: (x,y,z) = the cell that is currently processed, velocity/rho = the velocity and density of the
* equilibrium distribution, omega = relaxation parameter that corresponds to the lattice viscosity
* 10. template< typename LatticeModel_T >
* 10. "template< typename LatticeModel_T >
* real_t forceTerm( const cell_idx_t x, const cell_idx_t y, const cell_idx_t z,
* const Vector3<real_t> & velocity, const real_t rho,
* const DirectionIndependentTerms_T & commonTerms,
* const real_t w, const real_t cx, const real_t cy, const real_t cz, const real_t omega ) const:
* const real_t w, const real_t cx, const real_t cy, const real_t cz, const real_t omega ) const":
* -> must evaluate the force term of the LBM collision step - called from the LB compute kernel for every lattice
* direction of cell (x,y,z)
* Parameters: (x,y,z) = the cell that is currently processed, velocity/rho = the velocity and density of the
* equilibrium distribution, commonTerms = direction-independent terms calculated by function
* "directionIndependentTerms" (see 9), w = lattice model weighting factor, (cx,cy,cz) = lattice
* direction, omega = relaxation parameter that corresponds to the lattice viscosity
* 11. bool setConstantBodyForceIfPossible( const Vector3<real_t> & force, const uint_t level = uint_t(0) ):
* 11. "bool setConstantBodyForceIfPossible( const Vector3<real_t> & force, const uint_t level = uint_t(0) )":
* -> Must return true if a constant force can be set. In that case, the force passed in must be set.
* 'level' is the grid level 'force' corresponds to.
*
......
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file QValueCellFilter.h
//! \file QCriterionCellFilter.h
//! \ingroup field
//! \author Lukas Werner <lks.werner@fau.de>
//
......
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file VectorFieldCellFilter.h
//! \file VelocityCellFilter.h
//! \ingroup field
//! \author Lukas Werner <lks.werner@fau.de>
//
......
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file VirtualMass.h
//! \file InitializeVirtualMassKernel.h
//! \author Lukas Werner <lks.werner@fau.de>
//
//======================================================================================================================
......
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file ParticleAccessorWithShapeAndVirtualMassWrapper.h
//! \file ParticleAccessorWithShapeVirtualMassWrapper.h
//! \author Lukas Werner <lks.werner@fau.de>
//
//======================================================================================================================
......
......@@ -393,8 +393,9 @@ inline bool EPA::EPA_Triangle::isClosestInternal() const
//*************************************************************************************************
/*! \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.
* Adds this support and the base points at bodies A and B to the vector.
* \param geom1 The body A.
* \param geom2 The body B.
* \param dir The support point direction.
* \param margin Extension of the Body.
*/
......@@ -425,8 +426,9 @@ inline void EPA::pushSupportMargin(const Support &geom1,
//*************************************************************************************************
/*! \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.
* Replaces the old value in the vectors at "IndexToReplace" with this support and the base points at bodies A and B.
* \param geom1 The body A.
* \param geom2 The body B.
* \param dir The support point direction.
* \param margin Extension of the Body.
*/
......
......@@ -42,10 +42,11 @@ GJK::GJK()
}
/**
* \brief Calculate a support point of a particle extended by threshold.
* \param geom support functions for particle 1 and 2.
* \brief Calculate a support point of a particle extended by a threshold.
* \param geom1 The body A.
* \param geom2 The body B.
* \param dir The support point direction.
* \param threshold Extension of the particle.
* \param margin The margin by which the objects will be enlarged.
*/
Vec3 GJK::putSupport(const Support &geom1,
const Support &geom2,
......
......@@ -94,7 +94,7 @@ inline void InitParticlesForHCSITS::operator()(size_t j, Accessor& ac, real_t dt
* \param ac The particle accessor
* \param body The body whose velocities to time integrate
* \param dv On return the initial linear velocity correction.
* \param w On return the initial angular velocity correction.
* \param dw On return the initial angular velocity correction.
* \param dt The time step size.
* \return void
*
......
......@@ -102,6 +102,7 @@ inline void IntegrateParticlesHCSITS::operator()(size_t j, PAccessor& ac, real_t
//*************************************************************************************************
/*!\brief Time integration of the position and orientation of a given body.
*
* \param ac The particle accessor
* \param body The body whose position and orientation to time integrate
* \param v The linear velocity to use for time integration of the position.
* \param w The angular velocity to use for time integration of the orientation.
......
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file PrepareDistanceComputations.h
//! \file BlockExclusion.h
//! \ingroup mesh
//! \author Christian Godenschwager <christian.godenschwager@fau.de>
//
......
......@@ -13,7 +13,7 @@
// You should have received a copy of the GNU General Public License along
// with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
//
//! \file Initialization.h
//! \file BlockForestInitialization.h
//! \ingroup mesh
//! \author Christian Godenschwager <christian.godenschwager@fau.de>
//
......
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