Skip to content
Snippets Groups Projects
Commit deeb23f6 authored by Dmitri Naumov's avatar Dmitri Naumov
Browse files

[MeL] Add missing parameter documentation.

parent 493f979a
No related branches found
No related tags found
No related merge requests found
...@@ -140,7 +140,9 @@ Mesh* generateRegularQuadMesh(const BaseLib::ISubdivision &div_x, ...@@ -140,7 +140,9 @@ Mesh* generateRegularQuadMesh(const BaseLib::ISubdivision &div_x,
* *
* \param length Mesh's dimensions in x- and y-directions. * \param length Mesh's dimensions in x- and y-directions.
* \param subdivision Number of subdivisions. * \param subdivision Number of subdivisions.
* \param origin Optional mesh's origin (the lower left corner) with MathLib::ORIGIN default. * \param origin Optional mesh's origin (the lower left corner) with
* MathLib::ORIGIN default.
* \param mesh_name Name of the new mesh.
*/ */
Mesh* generateRegularQuadMesh(const double length, Mesh* generateRegularQuadMesh(const double length,
const std::size_t subdivision, const std::size_t subdivision,
...@@ -155,7 +157,9 @@ Mesh* generateRegularQuadMesh(const double length, ...@@ -155,7 +157,9 @@ Mesh* generateRegularQuadMesh(const double length,
* \param y_length Mesh's dimension in y-direction. * \param y_length Mesh's dimension in y-direction.
* \param x_subdivision Number of subdivisions in x-direction. * \param x_subdivision Number of subdivisions in x-direction.
* \param y_subdivision Number of subdivisions in y-direction. * \param y_subdivision Number of subdivisions in y-direction.
* \param origin Optional mesh's origin (the lower left corner) with MathLib::ORIGIN default. * \param origin Optional mesh's origin (the lower left corner) with
* MathLib::ORIGIN default.
* \param mesh_name Name of the new mesh.
*/ */
Mesh* generateRegularQuadMesh(const double x_length, Mesh* generateRegularQuadMesh(const double x_length,
const double y_length, const double y_length,
...@@ -198,15 +202,15 @@ Mesh* generateRegularQuadMesh(const unsigned n_x_cells, ...@@ -198,15 +202,15 @@ Mesh* generateRegularQuadMesh(const unsigned n_x_cells,
MathLib::Point3d const& origin = MathLib::ORIGIN, MathLib::Point3d const& origin = MathLib::ORIGIN,
std::string const& mesh_name = "mesh"); std::string const& mesh_name = "mesh");
/** /**
* Generate a regular 3D Hex-Element mesh. * Generate a regular 3D Hex-Element mesh.
* *
* \param div_x Subdivision operator in x direction * \param div_x Subdivision operator in x direction
* \param div_y Subdivision operator in y direction * \param div_y Subdivision operator in y direction
* \param div_z Subdivision operator in z direction * \param div_z Subdivision operator in z direction
* \param origin Optional mesh's origin (the bottom lower left corner) with MathLib::ORIGIN default. * \param origin Optional mesh's origin (the bottom lower left corner) with
* MathLib::ORIGIN default.
* \param mesh_name Name of the new mesh.
*/ */
Mesh* generateRegularHexMesh(const BaseLib::ISubdivision &div_x, Mesh* generateRegularHexMesh(const BaseLib::ISubdivision &div_x,
const BaseLib::ISubdivision &div_y, const BaseLib::ISubdivision &div_y,
...@@ -292,7 +296,9 @@ Mesh* generateRegularHexMesh(const unsigned n_x_cells, ...@@ -292,7 +296,9 @@ Mesh* generateRegularHexMesh(const unsigned n_x_cells,
* *
* \param div_x Subdivision operator in x direction * \param div_x Subdivision operator in x direction
* \param div_y Subdivision operator in y direction * \param div_y Subdivision operator in y direction
* \param origin Optional mesh's origin (the bottom lower left corner) with MathLib::ORIGIN default. * \param origin Optional mesh's origin (the bottom lower left corner) with
* MathLib::ORIGIN default.
* \param mesh_name Name of the new mesh.
*/ */
Mesh* generateRegularTriMesh(const BaseLib::ISubdivision &div_x, Mesh* generateRegularTriMesh(const BaseLib::ISubdivision &div_x,
const BaseLib::ISubdivision &div_y, const BaseLib::ISubdivision &div_y,
...@@ -305,7 +311,9 @@ Mesh* generateRegularTriMesh(const BaseLib::ISubdivision &div_x, ...@@ -305,7 +311,9 @@ Mesh* generateRegularTriMesh(const BaseLib::ISubdivision &div_x,
* *
* \param length Mesh's dimensions in x- and y-directions. * \param length Mesh's dimensions in x- and y-directions.
* \param subdivision Number of subdivisions. * \param subdivision Number of subdivisions.
* \param origin Optional mesh's origin (the lower left corner) with MathLib::ORIGIN default. * \param origin Optional mesh's origin (the lower left corner) with
* MathLib::ORIGIN default.
* \param mesh_name Name of the new mesh.
*/ */
Mesh* generateRegularTriMesh(const double length, Mesh* generateRegularTriMesh(const double length,
const std::size_t subdivision, const std::size_t subdivision,
...@@ -320,7 +328,9 @@ Mesh* generateRegularTriMesh(const double length, ...@@ -320,7 +328,9 @@ Mesh* generateRegularTriMesh(const double length,
* \param y_length Mesh's dimension in y-direction. * \param y_length Mesh's dimension in y-direction.
* \param x_subdivision Number of subdivisions in x-direction. * \param x_subdivision Number of subdivisions in x-direction.
* \param y_subdivision Number of subdivisions in y-direction. * \param y_subdivision Number of subdivisions in y-direction.
* \param origin Optional mesh's origin (the lower left corner) with MathLib::ORIGIN default. * \param origin Optional mesh's origin (the lower left corner) with
* MathLib::ORIGIN default.
* \param mesh_name Name of the new mesh.
*/ */
Mesh* generateRegularTriMesh(const double x_length, Mesh* generateRegularTriMesh(const double x_length,
const double y_length, const double y_length,
...@@ -372,7 +382,9 @@ Mesh* generateRegularTriMesh(const unsigned n_x_cells, ...@@ -372,7 +382,9 @@ Mesh* generateRegularTriMesh(const unsigned n_x_cells,
* \param x_subdivision Number of subdivisions in x-direction. * \param x_subdivision Number of subdivisions in x-direction.
* \param y_subdivision Number of subdivisions in y-direction. * \param y_subdivision Number of subdivisions in y-direction.
* \param z_subdivision Number of subdivisions in z-direction. * \param z_subdivision Number of subdivisions in z-direction.
* \param origin Optional mesh's origin (the lower left corner) with MathLib::ORIGIN default. * \param origin Optional mesh's origin (the lower left corner) with
* MathLib::ORIGIN default.
* \param mesh_name Name of the new mesh.
*/ */
Mesh* generateRegularPrismMesh(const double x_length, Mesh* generateRegularPrismMesh(const double x_length,
const double y_length, const double y_length,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment