mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: Doxygen docs - using Note instead of \note
This commit is contained in:
andy
@ -57,7 +57,7 @@ Description
|
||||
refGrad | patch normal gradient | yes |
|
||||
\endtable
|
||||
|
||||
\note
|
||||
Note
|
||||
This condition is not usually applied directly; instead, use a derived
|
||||
mixed condition such as \c inletOutlet
|
||||
|
||||
|
||||
@ -31,11 +31,6 @@ Description
|
||||
This boundary condition enforces a cyclic condition between a pair of
|
||||
boundaries.
|
||||
|
||||
\note
|
||||
The patches must be topologically similar, i.e. if the owner patch is
|
||||
transformed to the neighbour patch, the patches should be identical (or
|
||||
very similar).
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
Example of the boundary condition specification:
|
||||
@ -46,6 +41,11 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
The patches must be topologically similar, i.e. if the owner patch is
|
||||
transformed to the neighbour patch, the patches should be identical (or
|
||||
very similar).
|
||||
|
||||
SourceFiles
|
||||
cyclicFvPatchField.C
|
||||
|
||||
|
||||
@ -32,11 +32,6 @@ Description
|
||||
boundaries, whereby communication between the patches is performed using
|
||||
an arbitrary mesh interface (AMI) interpolation.
|
||||
|
||||
\note
|
||||
The outer boundary of the patch pairs must be similar, i.e. if the owner
|
||||
patch is transformed to the neighbour patch, the outer perimiter of each
|
||||
patch should be identical (or very similar).
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
Example of the boundary condition specification:
|
||||
@ -47,6 +42,11 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
The outer boundary of the patch pairs must be similar, i.e. if the owner
|
||||
patch is transformed to the neighbour patch, the outer perimiter of each
|
||||
patch should be identical (or very similar).
|
||||
|
||||
SeeAlso
|
||||
Foam::AMIInterpolation
|
||||
|
||||
|
||||
@ -58,22 +58,19 @@ Description
|
||||
lInf | distance beyond patch for \c fieldInf | no |
|
||||
\endtable
|
||||
|
||||
\note
|
||||
If \c lInf is specified, \c fieldInf will be required; \c rho is only
|
||||
required in the case of a mass-based flux.
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
{
|
||||
type advective;
|
||||
phi phi;
|
||||
// rho rho; // Not needed for volumetric-based flux
|
||||
// fieldInf 1e5; // Optional
|
||||
// lInf 0.1; // Optional
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
If \c lInf is specified, \c fieldInf will be required; \c rho is only
|
||||
required in the case of a mass-based flux.
|
||||
|
||||
SourceFiles
|
||||
advectiveFvPatchField.C
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
The \c axialVelocity, \c radialVelocity and \c rpm entries are DataEntry
|
||||
types, able to describe time varying functions. The example above gives
|
||||
the usage for supplying constant values.
|
||||
|
||||
@ -66,7 +66,7 @@ Description
|
||||
The above example shows the use of a comma separated (CSV) file to specify
|
||||
the jump condition.
|
||||
|
||||
\note
|
||||
Note
|
||||
The underlying \c patchType should be set to \c cyclic
|
||||
|
||||
SeeAlso
|
||||
|
||||
@ -43,7 +43,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
This is used as a base for conditions such as the turbulence \c epsilon
|
||||
wall function, which applies a near-wall constraint for high Reynolds
|
||||
number flows.
|
||||
|
||||
@ -30,7 +30,7 @@ Group
|
||||
Description
|
||||
Base class for "jump" of a field<type>
|
||||
|
||||
\note
|
||||
Note
|
||||
not used directly
|
||||
|
||||
SeeAlso
|
||||
|
||||
@ -64,7 +64,7 @@ Description
|
||||
The \c flowRate entry is a \c DataEntry type, meaning that it can be
|
||||
specified as constant, a polynomial fuction of time, and ...
|
||||
|
||||
\note
|
||||
Note
|
||||
- the value is positive into the domain (as an inlet)
|
||||
- may not work correctly for transonic inlets
|
||||
- strange behaviour with potentialFoam since the U equation is not solved
|
||||
|
||||
@ -64,7 +64,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
If reverse flow is possible or expected use the
|
||||
pressureInletOutletVelocity condition instead.
|
||||
|
||||
|
||||
@ -42,7 +42,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
This condition is designed to operate with a freestream velocity condition
|
||||
|
||||
SeeAlso
|
||||
|
||||
@ -53,7 +53,7 @@ Description
|
||||
The mode of operation is determined by the sign of the flux across the
|
||||
patch faces.
|
||||
|
||||
\note
|
||||
Note
|
||||
Sign conventions:
|
||||
- positive flux (out of domain): apply zero-gradient condition
|
||||
- negative flux (into of domain): apply the user-specified fixed value
|
||||
|
||||
@ -53,7 +53,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
Since this condition can be applied on a per-field and per-patch basis,
|
||||
it is possible to duplicate the mapping information. If possible, employ
|
||||
the \c mapped condition in preference to avoid this situation, and only
|
||||
|
||||
@ -51,7 +51,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
This boundary condition can only be applied to patches that are of
|
||||
the \c mappedPolyPatch type.
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
This boundary condition can only be applied to patches that are of
|
||||
the \c mappedPolyPatch type.
|
||||
|
||||
|
||||
@ -65,7 +65,7 @@ Description
|
||||
boundary faces and both faces sample into the cell, both faces will get the
|
||||
same value.
|
||||
|
||||
\note
|
||||
Note
|
||||
It is not possible to sample internal faces since volume fields are not
|
||||
defined on faces.
|
||||
|
||||
|
||||
@ -51,7 +51,7 @@ Description
|
||||
The underlying sample mode should be set to \c nearestPatchFace or
|
||||
\c nearestFace
|
||||
|
||||
\note
|
||||
Note
|
||||
This boundary condition can only be applied to patches that are of
|
||||
the \c mappedPolyPatch type.
|
||||
|
||||
|
||||
@ -68,7 +68,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
The amplitude and frequency entries are DataEntry types, able to describe
|
||||
time varying functions. The example above gives the usage for supplying
|
||||
constant values.
|
||||
|
||||
@ -53,7 +53,7 @@ Description
|
||||
The mode of operation is determined by the sign of the flux across the
|
||||
patch faces.
|
||||
|
||||
\note
|
||||
Note
|
||||
Sign conventions:
|
||||
- positive flux (out of domain): apply the user-specified fixed value
|
||||
- negative flux (into of domain): apply zero-gradient condition
|
||||
|
||||
@ -54,7 +54,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
Sign conventions:
|
||||
- positive flux (out of domain): apply zero-gradient condition
|
||||
- negative flux (into of domain): derive from the flux with specified
|
||||
|
||||
@ -53,7 +53,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
If reverse flow is possible or expected use the
|
||||
pressureDirectedInletOutletVelocityFvPatchVectorField condition instead.
|
||||
|
||||
|
||||
@ -54,7 +54,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
Sign conventions:
|
||||
- positive flux (out of domain): apply zero-gradient condition
|
||||
- negative flux (into of domain): derive from the flux with specified
|
||||
|
||||
@ -54,7 +54,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
Sign conventions:
|
||||
- positive flux (out of domain): apply zero-gradient condition
|
||||
- negative flux (into of domain): derive from the flux in the patch-normal
|
||||
|
||||
@ -45,7 +45,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
If reverse flow is possible or expected use
|
||||
the pressureInletOutletVelocityFvPatchVectorField condition instead.
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
Sign conventions:
|
||||
- positive flux (out of domain): apply zero-gradient condition
|
||||
- negative flux (into of domain): derive from the flux and patch-normal
|
||||
|
||||
@ -56,7 +56,7 @@ Description
|
||||
The \c omega entry is a DataEntry type, able to describe time varying
|
||||
functions.
|
||||
|
||||
\note
|
||||
Note
|
||||
Sign conventions:
|
||||
- positive flux (out of domain): apply zero-gradient condition
|
||||
- negative flux (into of domain): derive from the flux in the patch-normal
|
||||
|
||||
@ -58,7 +58,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
This boundary condition is ill-posed if the free-stream flow is normal
|
||||
to the boundary.
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
Sign conventions:
|
||||
- the value is positive for outward-pointing vectors
|
||||
|
||||
|
||||
@ -57,7 +57,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
- the \c flowRate and \c rpm entries are DataEntry types, able to describe
|
||||
time varying functions. The example above gives the usage for supplying
|
||||
constant values.
|
||||
|
||||
@ -56,7 +56,7 @@ Description
|
||||
|
||||
The above example shows the use of a constant jump condition.
|
||||
|
||||
\note
|
||||
Note
|
||||
The underlying \c patchType should be set to \c cyclic
|
||||
|
||||
SeeAlso
|
||||
|
||||
@ -61,7 +61,7 @@ Description
|
||||
}
|
||||
/endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
Switch on debug flag to have it dump the triangulation (in transformed
|
||||
space) and transform face centres.
|
||||
|
||||
|
||||
@ -101,9 +101,6 @@ Description
|
||||
p0 | static pressure reference | yes |
|
||||
\endtable
|
||||
|
||||
\note
|
||||
The default boundary behaviour is for subsonic, incompressible flow.
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
@ -118,6 +115,9 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
The default boundary behaviour is for subsonic, incompressible flow.
|
||||
|
||||
SeeAlso
|
||||
Foam::fixedValueFvPatchField
|
||||
|
||||
|
||||
@ -46,7 +46,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
The uniformValue entry is a DataEntry type, able to describe time
|
||||
varying functions. The example above gives the usage for supplying a
|
||||
constant value.
|
||||
|
||||
@ -44,9 +44,6 @@ Description
|
||||
pressure | total pressure as a function of time | yes |
|
||||
\endtable
|
||||
|
||||
\note
|
||||
The default boundary behaviour is for subsonic, incompressible flow.
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
@ -62,10 +59,13 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
|
||||
The \c pressure entry is specified as a DataEntry type, able to describe
|
||||
time varying functions.
|
||||
|
||||
Note
|
||||
The default boundary behaviour is for subsonic, incompressible flow.
|
||||
|
||||
|
||||
SeeAlso
|
||||
Foam::DataEntry
|
||||
Foam::uniformFixedValueFvPatchField
|
||||
|
||||
@ -51,7 +51,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
- the value is positive into the domain
|
||||
- may not work correctly for transonic inlets
|
||||
- strange behaviour with potentialFoam since the momentum equation is
|
||||
|
||||
@ -44,9 +44,6 @@ Description
|
||||
- base: average over 'time', or 'iteration' (\f$N\f$ in the above)
|
||||
- window: optional averaging window, specified in 'base' units
|
||||
|
||||
\note
|
||||
To employ the \c prime2Mean option, the \c mean option must be selecetd.
|
||||
|
||||
Average field names are constructed by concatenating the base field with
|
||||
the averaging type, e.g. when averaging field 'U', the resultant fields
|
||||
are:
|
||||
@ -99,6 +96,9 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
To employ the \c prime2Mean option, the \c mean option must be selecetd.
|
||||
|
||||
SourceFiles
|
||||
fieldAverage.C
|
||||
fieldAverageTemplates.C
|
||||
|
||||
@ -74,7 +74,7 @@ Description
|
||||
For example, to calculate the volumetric or mass flux across a patch,
|
||||
apply the 'sum' operator to the flux field (typically \c phi)
|
||||
|
||||
\note
|
||||
Note
|
||||
- faces on empty patches get ignored
|
||||
- if the field is a volField the \c faceZone can only consist of boundary
|
||||
faces
|
||||
|
||||
@ -46,9 +46,6 @@ Description
|
||||
L | length scale
|
||||
\endvartable
|
||||
|
||||
\note
|
||||
In the event of reverse flow, a zero-gradient condition is applied
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
\table
|
||||
@ -68,6 +65,9 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
In the event of reverse flow, a zero-gradient condition is applied
|
||||
|
||||
SeeAlso
|
||||
Foam::inletOutletFvPatchField
|
||||
|
||||
|
||||
@ -45,9 +45,6 @@ Description
|
||||
L | length scale
|
||||
\endvartable
|
||||
|
||||
\note
|
||||
In the event of reverse flow, a zero-gradient condition is applied
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
\table
|
||||
@ -67,6 +64,9 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
In the event of reverse flow, a zero-gradient condition is applied
|
||||
|
||||
SeeAlso
|
||||
Foam::inletOutletFvPatchField
|
||||
|
||||
|
||||
@ -55,8 +55,8 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Only supply \h an \c Ta, or \c q in the dictionary (see above)
|
||||
Note
|
||||
Only supply \c h and \c Ta, or \c q in the dictionary (see above)
|
||||
|
||||
SourceFiles
|
||||
externalWallHeatFluxTemperatureFvPatchScalarField.C
|
||||
|
||||
@ -73,7 +73,7 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
\note
|
||||
Note
|
||||
The underlying \c patchType should be set to \c cyclic
|
||||
|
||||
SourceFiles
|
||||
|
||||
@ -64,12 +64,6 @@ Description
|
||||
layer", Journal of Wind Engineering and Industrial Aerodynamics
|
||||
95(2007), pp 355-369.
|
||||
|
||||
\note
|
||||
D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the
|
||||
k-epsilon model should be changed from 1.3 to 1.11 for consistency.
|
||||
The roughness height (Er) is given by Er = 20 z0 following the same
|
||||
reference.
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
\table
|
||||
@ -98,6 +92,12 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
D.M. Hargreaves and N.G. Wright recommend Gamma epsilon in the
|
||||
k-epsilon model should be changed from 1.3 to 1.11 for consistency.
|
||||
The roughness height (Er) is given by Er = 20 z0 following the same
|
||||
reference.
|
||||
|
||||
SourceFiles
|
||||
atmBoundaryLayerInletVelocityFvPatchVectorField.C
|
||||
|
||||
|
||||
@ -41,11 +41,6 @@ Description
|
||||
alphaEff | turbulent thermal diffusivity field name | yes |
|
||||
\endtable
|
||||
|
||||
\note
|
||||
- it is assumed that the units of \c alphaEff are [kg/m/s]
|
||||
- the specific heat capcaity is read from the transport dictionary entry
|
||||
\c Cp0
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
@ -58,6 +53,11 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
- it is assumed that the units of \c alphaEff are [kg/m/s]
|
||||
- the specific heat capcaity is read from the transport dictionary entry
|
||||
\c Cp0
|
||||
|
||||
SourceFiles
|
||||
turbulentHeatFluxTemperatureFvPatchScalarField.C
|
||||
|
||||
|
||||
@ -46,9 +46,6 @@ Description
|
||||
L | length scale
|
||||
\endvartable
|
||||
|
||||
\note
|
||||
In the event of reverse flow, a zero-gradient condition is applied
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
\table
|
||||
@ -68,6 +65,9 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
In the event of reverse flow, a zero-gradient condition is applied
|
||||
|
||||
SeeAlso
|
||||
Foam::inletOutletFvPatchField
|
||||
|
||||
|
||||
@ -45,9 +45,6 @@ Description
|
||||
L | length scale
|
||||
\endvartable
|
||||
|
||||
\note
|
||||
In the event of reverse flow, a zero-gradient condition is applied
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
\table
|
||||
@ -67,6 +64,9 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
In the event of reverse flow, a zero-gradient condition is applied
|
||||
|
||||
SeeAlso
|
||||
Foam::inletOutletFvPatchField
|
||||
|
||||
|
||||
@ -32,9 +32,6 @@ Description
|
||||
This boundary condition provides a kinematic turbulent thermal conductivity
|
||||
for using wall functions, using the Jayatilleke 'P' function.
|
||||
|
||||
\note
|
||||
The units of kinematic turbulent thermal conductivity are m2/s
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
\table
|
||||
@ -53,6 +50,9 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
The units of kinematic turbulent thermal conductivity are [m2/s]
|
||||
|
||||
SeeAlso
|
||||
Foam::fixedValueFvPatchField
|
||||
|
||||
|
||||
@ -33,10 +33,6 @@ Description
|
||||
of U+ as a function of near-wall Reynolds number. The table should be
|
||||
located in the $FOAM_CASE/constant folder.
|
||||
|
||||
\note
|
||||
the tables are not registered since the same table object may be used for
|
||||
more than one patch.
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
\table
|
||||
@ -53,6 +49,10 @@ Description
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
Note
|
||||
The tables are not registered since the same table object may be used for
|
||||
more than one patch.
|
||||
|
||||
SeeAlso
|
||||
Foam::nutWallFunctionFvPatchScalarField
|
||||
|
||||
|
||||
Reference in New Issue
Block a user