STYLE: add usage notes to more utilities and solvers

This commit is contained in:
Mark Olesen
2018-12-11 15:25:27 +01:00
parent ee5199cc65
commit 68ec561df8
224 changed files with 1336 additions and 238 deletions

View File

@ -28,8 +28,9 @@ Group
grpCompressibleSolvers grpMovingMeshSolvers
Description
Density-based compressible flow solver based on central-upwind schemes of
Kurganov and Tadmor with support for mesh-motion and topology changes.
Density-based compressible flow solver based on central-upwind
schemes of Kurganov and Tadmor
with support for mesh-motion and topology changes.
\*---------------------------------------------------------------------------*/
@ -47,6 +48,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Density-based compressible flow solver based on central-upwind"
" schemes of Kurganov and Tadmor.\n"
"With support for mesh-motion and topology changes."
);
#define NO_CONTROL
#include "postProcess.H"

View File

@ -28,8 +28,8 @@ Group
grpCompressibleSolvers
Description
Density-based compressible flow solver based on central-upwind schemes of
Kurganov and Tadmor.
Density-based compressible flow solver based on central-upwind
schemes of Kurganov and Tadmor.
\*---------------------------------------------------------------------------*/
@ -45,6 +45,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Density-based compressible flow solver based on central-upwind"
" schemes of Kurganov and Tadmor."
);
#define NO_CONTROL
#include "postProcess.H"

View File

@ -58,6 +58,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for laminar or turbulent flow"
" of weakly compressible fluids for low Mach number"
" aeroacoustic applications."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -54,6 +54,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for compressible turbulent flow.\n"
"With optional mesh motion and mesh topology changes."
);
#include "setRootCase.H"
#include "createTime.H"
#include "createDynamicFvMesh.H"

View File

@ -52,6 +52,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for compressible turbulent flow.\n"
"With optional mesh motion and mesh topology changes."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,7 +28,7 @@ Group
grpCompressibleSolvers
Description
Overset steady-state solver for turbulent flow of compressible fluids.
Overset steady-state solver for compressible turbulent flow.
\*---------------------------------------------------------------------------*/
@ -47,6 +47,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Overset steady-state solver for compressible turbulent flow"
);
#define CREATE_MESH createUpdatedDynamicFvMesh.H
#include "postProcess.H"

View File

@ -28,8 +28,8 @@ Group
grpCompressibleSolvers
Description
Steady-state solver for turbulent flow of compressible fluids, with
implicit or explicit porosity treatment and optional sources.
Steady-state solver for compressible turbulent flow,
with implicit or explicit porosity treatment and optional sources.
\*---------------------------------------------------------------------------*/
@ -45,6 +45,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for compressible turbulent flow,"
"with implicit or explicit porosity treatment and optional sources."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -28,7 +28,7 @@ Group
grpCompressibleSolvers
Description
Steady-state solver for turbulent flow of compressible fluids.
Steady-state solver for compressible turbulent flow.
\*---------------------------------------------------------------------------*/
@ -43,6 +43,11 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Steady-state solver for compressible turbulent flow."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -45,6 +45,13 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for trans-sonic/supersonic, turbulent flow"
" of a compressible gas.\n"
"With optional mesh motion and mesh topology changes."
);
#include "postProcess.H"
#include "setRootCase.H"

View File

@ -43,6 +43,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for trans-sonic/supersonic, turbulent flow"
" of a compressible gas."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"

View File

@ -40,6 +40,12 @@ Description
int main(int argc, char *argv[])
{
argList::addNote
(
"Transient solver for trans-sonic/supersonic, laminar flow"
" of a compressible liquid."
);
#include "postProcess.H"
#include "addCheckCaseOptions.H"