zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: Doxygen updates

Browse Source
This commit is contained in:
andy
2014-02-05 18:33:28 +00:00
committed by Andrew Heather
parent a2e4c87786
commit ef52265131
7 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
applications/utilities/preProcessing/createExternalCoupledPatchGeometry/createExternalCoupledPatchGeometry.C
View File

@ -30,9 +30,9 @@ Description
Usage: Usage:
createExternalCoupledPatchGeometry <fieldName> createExternalCoupledPatchGeometry \<fieldName\>
On execution, the field <fieldName> is read, and its boundary conditions On execution, the field \<fieldName\> is read, and its boundary conditions
interrogated for the presence of an \c externalCoupled type. If found, interrogated for the presence of an \c externalCoupled type. If found,
the patch geometry (points and faces) for the coupled patches are output the patch geometry (points and faces) for the coupled patches are output
to the communications directory. to the communications directory.

4
src/OpenFOAM/meshes/lduMesh/lduPrimitiveMesh.C
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2013-2014 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -35,7 +35,7 @@ namespace Foam
{ {
defineTypeNameAndDebug(lduPrimitiveMesh, 0); defineTypeNameAndDebug(lduPrimitiveMesh, 0);
//- Less operator for pairs of <processor><index> //- Less operator for pairs of \<processor\>\<index\>
class procLess class procLess
{ {
const labelPairList& lst_; const labelPairList& lst_;

5
src/regionModels/surfaceFilmModels/submodels/kinematic/force/force/force.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::force Foam::regionModels::surfaceFilmModels::force
Description Description
Base class for film (stress-based) force models Base class for film (stress-based) force models
@ -30,6 +30,7 @@ Description
SourceFiles SourceFiles
force.C force.C
forceNew.C forceNew.C
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef force_H #ifndef force_H

5
src/regionModels/surfaceFilmModels/submodels/kinematic/injectionModel/injectionModel/injectionModel.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class Class
Foam::injectionModel Foam::regionModels::surfaceFilmModels::injectionModel
Description Description
Base class for film injection models, handling mass transfer from the Base class for film injection models, handling mass transfer from the
@ -31,6 +31,7 @@ Description
SourceFiles SourceFiles
injectionModel.C injectionModel.C
injectionModelNew.C injectionModelNew.C
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/
#ifndef injectionModel_H #ifndef injectionModel_H

1
src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/turbulentTemperatureCoupledBaffleMixed/turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.H
View File

@ -68,6 +68,7 @@ Description
kappaLayers (1 2 3 4) kappaLayers (1 2 3 4)
value uniform 300; value uniform 300;
} }
\endverbatim
Needs to be on underlying mapped(Wall)FvPatch. Needs to be on underlying mapped(Wall)FvPatch.

1
src/turbulenceModels/compressible/turbulenceModel/derivedFvPatchFields/turbulentTemperatureRadCoupledMixed/turbulentTemperatureRadCoupledMixedFvPatchScalarField.H
View File

@ -63,6 +63,7 @@ Description
kappaLayers (1 2 3 4) kappaLayers (1 2 3 4)
value uniform 300; value uniform 300;
} }
\endverbatim
Needs to be on underlying mapped(Wall)FvPatch. Needs to be on underlying mapped(Wall)FvPatch.

4
src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -28,7 +28,7 @@ Group
grpCoupledBoundaryConditions grpCoupledBoundaryConditions
Description Description
This boundary condition provides a jump condition, using the \cyclic This boundary condition provides a jump condition, using the \c cyclic
condition as a base. condition as a base.
The porous baffle introduces a pressure jump defined by: The porous baffle introduces a pressure jump defined by: