mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: Updates to function object documentation
This commit is contained in:
andy
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::partialWrite
|
||||
|
||||
\ingroup grpIOFunctionObjects
|
||||
Group
|
||||
grpIOFunctionObjects
|
||||
|
||||
Description
|
||||
Allows some fields/registered objects to be written more often than others.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::removeRegisteredObject
|
||||
|
||||
\ingroup grpIOFunctionObjects
|
||||
Group
|
||||
grpIOFunctionObjects
|
||||
|
||||
Description
|
||||
Removes registered IO objects if present in the database
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::writeRegisteredObject
|
||||
|
||||
\ingroup grpIOFunctionObjects
|
||||
Group
|
||||
grpIOFunctionObjects
|
||||
|
||||
Description
|
||||
Takes over the writing of registered IO objects
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::cloudInfo
|
||||
|
||||
\ingroup grpCloudFunctionObjects
|
||||
Group
|
||||
grpCloudFunctionObjects
|
||||
|
||||
Description
|
||||
This function object outputs lagrangian cloud information to a file. The
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::fieldAverage
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Calculates the field averages given list of fieldAverageItems, e.g.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
class
|
||||
Foam::fieldCoordinateSystemTransform
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Transforms fields from global cartesian co-ordinates to local co-ordinate
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::fieldMinMax
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Calculates scalar minimim and maximum field values.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::fieldValue
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Base class for field value -based function objects.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::nearWallFields
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Samples near-patch volFields
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::processorField
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Writes a scalar field whose value is the local processor ID. Output
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::readFields
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Reads fields from the time folders and adds them to the mesh database
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::regionSizeDistribution
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Looks up a field, interpolates it to the faces and determines a connected
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::streamLine
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Generation of streamlines. Samples along track of passive particle.
|
||||
|
||||
@ -24,7 +24,7 @@ License
|
||||
Class
|
||||
Foam::surfaceInterpolateFields
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Linear interpolates volFields to surfaceFields
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::turbulenceFields
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Stores turbulence fields on the mesh database for further manipulation.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::wallBoundedStreamLine
|
||||
|
||||
\ingroup grpFieldFunctionObjects
|
||||
Group
|
||||
grpFieldFunctionObjects
|
||||
|
||||
Description
|
||||
Generation of streamlines. Samples along track of passive particle.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::forceCoeffs
|
||||
|
||||
\ingroup grpForcesFunctionObjects
|
||||
Group
|
||||
grpForcesFunctionObjects
|
||||
|
||||
Description
|
||||
Derived from the forces function object, creates a specialisation to
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::forces
|
||||
|
||||
\ingroup grpForcesFunctionObjects
|
||||
Group
|
||||
grpForcesFunctionObjects
|
||||
|
||||
Description
|
||||
Calculates the forces and moments by integrating the pressure and
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::abortCalculation
|
||||
|
||||
\ingroup grpJobControlFunctionObjects
|
||||
Group
|
||||
grpJobControlFunctionObjects
|
||||
|
||||
Description
|
||||
Watches for presence of the named file in the $FOAM_CASE directory
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::systemCall
|
||||
|
||||
\ingroup grpFunctionObjects
|
||||
Group
|
||||
grpFunctionObjects
|
||||
|
||||
Description
|
||||
Executes system calls, entered in the form of a string list
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::codedFunctionObject
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
functionObject using dynamic code compilation.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::dsmcFields
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Calculate intensive fields:
|
||||
|
||||
@ -24,18 +24,28 @@ License
|
||||
Class
|
||||
Foam::pressureCoefficient
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Calculates pressure coefficient, \f$c_p\f$
|
||||
|
||||
\f[
|
||||
c_p = p/p_{dyn,inf}
|
||||
c_p = \frac{p}{p_{dyn,inf}}
|
||||
\f]
|
||||
where:
|
||||
\f[
|
||||
p_{dyn,inf} = 0.5 \rho |U_{inf}|^2
|
||||
\f]
|
||||
|
||||
where:
|
||||
where
|
||||
\vartable
|
||||
c_p | pressure coefficient
|
||||
p | pressure [bar]
|
||||
\rho | density [kg/m3]
|
||||
U | velocity [m/s]
|
||||
\endvartable
|
||||
|
||||
p_dyn,inf = 0.5*rho*mag(U_inf)^2
|
||||
|
||||
SourceFiles
|
||||
pressureCoefficient.C
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::staticPressure
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Converts kinematic pressure to static pressure, from the name of the
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::timeActivatedFileUpdate
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Performs a file copy/replacement once a specified time has been reached.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::yPlusLES
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Evaluates and outputs turbulence y+ for LES models. Values written to
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::yPlusRAS
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Evaluates and outputs turbulence y+ for RAS models. Values written to
|
||||
|
||||
@ -21,12 +21,12 @@ License
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
\addtogroup functionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::probes
|
||||
|
||||
Group
|
||||
grpFunctionObjects
|
||||
|
||||
Description
|
||||
Set of locations to sample.
|
||||
|
||||
@ -34,7 +34,6 @@ Description
|
||||
|
||||
SourceFiles
|
||||
probes.C
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,12 @@ License
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
\addtogroup functionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::sampledSet
|
||||
|
||||
Group
|
||||
grpFunctionObjects
|
||||
|
||||
Description
|
||||
Holds list of sampling points which is filled at construction time.
|
||||
Various implementations of this base class to e.g. get sampling points
|
||||
@ -38,7 +38,6 @@ Description
|
||||
|
||||
SourceFiles
|
||||
sampledSet.C
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
@ -21,12 +21,12 @@ License
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
\addtogroup functionObjects
|
||||
@{
|
||||
|
||||
Class
|
||||
Foam::sampledSurface
|
||||
|
||||
Group
|
||||
grpFunctionObjects
|
||||
|
||||
Description
|
||||
An abstract class for surfaces with sampling.
|
||||
|
||||
@ -46,7 +46,6 @@ Description
|
||||
SourceFiles
|
||||
sampledSurface.C
|
||||
sampledSurfaceTemplates.C
|
||||
@}
|
||||
|
||||
\*---------------------------------------------------------------------------*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user