mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-12-28 03:37:59 +00:00
STYLE: add usage notes to more utilities and solvers
This commit is contained in:
@ -261,6 +261,11 @@ void changeFrontBackPatches
|
||||
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
argList::addNote
|
||||
(
|
||||
"Extrude mesh from existing patch."
|
||||
);
|
||||
|
||||
#include "addRegionOption.H"
|
||||
#include "setRootCase.H"
|
||||
#include "createTimeExtruded.H"
|
||||
|
||||
@ -1462,7 +1462,10 @@ void extrudeGeometricProperties
|
||||
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
argList::addNote("Create region mesh by extruding a faceZone or faceSet");
|
||||
argList::addNote
|
||||
(
|
||||
"Create region mesh by extruding a faceZone or faceSet"
|
||||
);
|
||||
|
||||
#include "addRegionOption.H"
|
||||
#include "addOverwriteOption.H"
|
||||
|
||||
@ -28,8 +28,8 @@ Group
|
||||
grpMeshGenerationUtilities
|
||||
|
||||
Description
|
||||
Takes 2D mesh (all faces 2 points only, no front and back faces) and
|
||||
creates a 3D mesh by extruding with specified thickness.
|
||||
Create a 3D mesh by extruding a 2D mesh with specified thickness.
|
||||
For the 2D mesh, all faces are 2 points only, no front and back faces.
|
||||
|
||||
Note
|
||||
Not sure about the walking of the faces to create the front and back faces.
|
||||
@ -110,6 +110,11 @@ static const Enum<ExtrudeMode> ExtrudeModeNames
|
||||
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
argList::addNote
|
||||
(
|
||||
"Create a 3D mesh from a 2D mesh by extruding with specified thickness"
|
||||
);
|
||||
|
||||
argList::addArgument("surfaceFormat");
|
||||
|
||||
#include "addOverwriteOption.H"
|
||||
|
||||
@ -45,6 +45,10 @@ using namespace Foam;
|
||||
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
argList::addNote
|
||||
(
|
||||
"Conformal Voronoi automatic mesh generator"
|
||||
);
|
||||
argList::addBoolOption
|
||||
(
|
||||
"checkGeometry",
|
||||
|
||||
@ -53,6 +53,11 @@ using namespace Foam;
|
||||
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
argList::addNote
|
||||
(
|
||||
"Conformal Voronoi 2D automatic mesh generator"
|
||||
);
|
||||
|
||||
argList::noParallel();
|
||||
argList::addOption("pointsFile", "filename");
|
||||
|
||||
|
||||
Reference in New Issue
Block a user