mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
STYLE: correct the documented input names in header files (fixes #360)
This commit is contained in:
@ -161,7 +161,7 @@ FoamFile
|
|||||||
// source fieldToCell;
|
// source fieldToCell;
|
||||||
// sourceInfo
|
// sourceInfo
|
||||||
// {
|
// {
|
||||||
// fieldName U; // Note: uses mag(U) since volVectorField
|
// field U; // Note: uses mag(U) since volVectorField
|
||||||
// min 0.1;
|
// min 0.1;
|
||||||
// max 0.5;
|
// max 0.5;
|
||||||
// }
|
// }
|
||||||
|
|||||||
@ -30,12 +30,12 @@ Group
|
|||||||
Description
|
Description
|
||||||
This boundary condition provides a self-contained version of the \c mapped
|
This boundary condition provides a self-contained version of the \c mapped
|
||||||
condition. It does not use information on the patch; instead it holds
|
condition. It does not use information on the patch; instead it holds
|
||||||
thr data locally.
|
the data locally.
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
\table
|
\table
|
||||||
Property | Description | Required | Default value
|
Property | Description | Required | Default value
|
||||||
fieldName | name of field to be mapped | no | this field name
|
field | name of field to be mapped | no | this field name
|
||||||
setAverage | flag to activate setting of average value | yes |
|
setAverage | flag to activate setting of average value | yes |
|
||||||
average | average value to apply if \c setAverage = yes | yes |
|
average | average value to apply if \c setAverage = yes | yes |
|
||||||
\endtable
|
\endtable
|
||||||
@ -45,7 +45,7 @@ Usage
|
|||||||
<patchName>
|
<patchName>
|
||||||
{
|
{
|
||||||
type mappedField;
|
type mappedField;
|
||||||
fieldName T; // optional field name
|
field T; // optional field name
|
||||||
setAverage no; // apply an average value
|
setAverage no; // apply an average value
|
||||||
average 0; // average to apply if setAverage
|
average 0; // average to apply if setAverage
|
||||||
value uniform 0; // place holder
|
value uniform 0; // place holder
|
||||||
|
|||||||
@ -32,7 +32,7 @@ Description
|
|||||||
Example usage:
|
Example usage:
|
||||||
|
|
||||||
{
|
{
|
||||||
fieldName T; // default is same as fvPatchField
|
field T; // default is same as fvPatchField
|
||||||
setAverage false;
|
setAverage false;
|
||||||
average 1.0; // only if setAverage=true
|
average 1.0; // only if setAverage=true
|
||||||
interpolationScheme cellPoint; // default is cell
|
interpolationScheme cellPoint; // default is cell
|
||||||
@ -58,7 +58,7 @@ class mappedPatchBase;
|
|||||||
template<class> class interpolation;
|
template<class> class interpolation;
|
||||||
|
|
||||||
/*---------------------------------------------------------------------------*\
|
/*---------------------------------------------------------------------------*\
|
||||||
Class mappedPatchFieldBase Declaration
|
Class mappedPatchFieldBase Declaration
|
||||||
\*---------------------------------------------------------------------------*/
|
\*---------------------------------------------------------------------------*/
|
||||||
|
|
||||||
template<class Type>
|
template<class Type>
|
||||||
|
|||||||
@ -34,7 +34,7 @@ Description
|
|||||||
Usage
|
Usage
|
||||||
\table
|
\table
|
||||||
Property | Description | Required | Default value
|
Property | Description | Required | Default value
|
||||||
fieldName | name of field to be mapped | no | this field name
|
field | name of field to be mapped | no | this field name
|
||||||
setAverage | flag to activate setting of average value | yes |
|
setAverage | flag to activate setting of average value | yes |
|
||||||
average | average value to apply if \c setAverage = yes | yes |
|
average | average value to apply if \c setAverage = yes | yes |
|
||||||
\endtable
|
\endtable
|
||||||
@ -43,7 +43,7 @@ Usage
|
|||||||
<patchName>
|
<patchName>
|
||||||
{
|
{
|
||||||
type mappedFixedInternalValue;
|
type mappedFixedInternalValue;
|
||||||
fieldName T;
|
field T;
|
||||||
setAverage no;
|
setAverage no;
|
||||||
average 0;
|
average 0;
|
||||||
value uniform 0;
|
value uniform 0;
|
||||||
|
|||||||
@ -34,7 +34,7 @@ Description
|
|||||||
Usage
|
Usage
|
||||||
\table
|
\table
|
||||||
Property | Description | Required | Default value
|
Property | Description | Required | Default value
|
||||||
fieldName | name of field to be mapped | no | this field name
|
field | name of field to be mapped | no | this field name
|
||||||
setAverage | flag to activate setting of average value | yes |
|
setAverage | flag to activate setting of average value | yes |
|
||||||
average | average value to apply if \c setAverage = yes | yes |
|
average | average value to apply if \c setAverage = yes | yes |
|
||||||
\endtable
|
\endtable
|
||||||
@ -44,7 +44,7 @@ Usage
|
|||||||
<patchName>
|
<patchName>
|
||||||
{
|
{
|
||||||
type mappedFixedPushedInternalValue;
|
type mappedFixedPushedInternalValue;
|
||||||
fieldName T;
|
field T;
|
||||||
setAverage no;
|
setAverage no;
|
||||||
average 0;
|
average 0;
|
||||||
value uniform 0;
|
value uniform 0;
|
||||||
|
|||||||
@ -37,7 +37,7 @@ Description
|
|||||||
Usage
|
Usage
|
||||||
\table
|
\table
|
||||||
Property | Description | Required | Default value
|
Property | Description | Required | Default value
|
||||||
fieldName | name of field to be mapped | no | this field name
|
field | name of field to be mapped | no | this field name
|
||||||
setAverage | flag to activate setting of average value | yes |
|
setAverage | flag to activate setting of average value | yes |
|
||||||
average | average value to apply if \c setAverage = yes | yes |
|
average | average value to apply if \c setAverage = yes | yes |
|
||||||
interpolationScheme | type of interpolation scheme | no |
|
interpolationScheme | type of interpolation scheme | no |
|
||||||
@ -48,7 +48,7 @@ Usage
|
|||||||
<patchName>
|
<patchName>
|
||||||
{
|
{
|
||||||
type mapped;
|
type mapped;
|
||||||
fieldName T;
|
field T;
|
||||||
setAverage no;
|
setAverage no;
|
||||||
average 0;
|
average 0;
|
||||||
interpolationScheme cell;
|
interpolationScheme cell;
|
||||||
|
|||||||
@ -103,8 +103,8 @@ Usage
|
|||||||
\table
|
\table
|
||||||
Property | Description | Required | Default value
|
Property | Description | Required | Default value
|
||||||
type | type name: fieldAverage | yes |
|
type | type name: fieldAverage | yes |
|
||||||
restartOnRestart| Restart the averaging on restart | no | no
|
restartOnRestart | Restart the averaging on restart | no | no
|
||||||
restartOnOutput | Restart the averaging on output | no | no
|
restartOnOutput | Restart the averaging on output | no | no
|
||||||
periodicRestart | Periodically restart the averaging | no | no
|
periodicRestart | Periodically restart the averaging | no | no
|
||||||
restartPeriod | Periodic restart period | conditional |
|
restartPeriod | Periodic restart period | conditional |
|
||||||
restartTime | One-shot reset of the averaging | no | great
|
restartTime | One-shot reset of the averaging | no | great
|
||||||
|
|||||||
@ -41,7 +41,7 @@ Usage
|
|||||||
...
|
...
|
||||||
writeToFile yes;
|
writeToFile yes;
|
||||||
log yes;
|
log yes;
|
||||||
functionObjectName forceCoeffs1;
|
functionObject forceCoeffs1;
|
||||||
fields (Cm Cd Cl);
|
fields (Cm Cd Cl);
|
||||||
window 0.5;
|
window 0.5;
|
||||||
}
|
}
|
||||||
@ -54,6 +54,8 @@ Usage
|
|||||||
writeToFile | write average data to file | no | yes
|
writeToFile | write average data to file | no | yes
|
||||||
log | write average data to standard output | no | yes
|
log | write average data to standard output | no | yes
|
||||||
fields | list of fields to process | yes |
|
fields | list of fields to process | yes |
|
||||||
|
functionObject | Name of function object to retrieve data from | yes |
|
||||||
|
resetOnRestart | Reset the averaging on restart | yes |
|
||||||
\endtable
|
\endtable
|
||||||
|
|
||||||
Output data is written to the file \<timeDir\>/valueAverage.dat
|
Output data is written to the file \<timeDir\>/valueAverage.dat
|
||||||
@ -107,7 +109,7 @@ protected:
|
|||||||
//- Average time per field
|
//- Average time per field
|
||||||
List<scalar> totalTime_;
|
List<scalar> totalTime_;
|
||||||
|
|
||||||
//- Reset the averaging process on restart flag
|
//- Reset the averaging process on restart
|
||||||
bool resetOnRestart_;
|
bool resetOnRestart_;
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -58,7 +58,7 @@ Usage
|
|||||||
\verbatim
|
\verbatim
|
||||||
actuationDiskSourceCoeffs
|
actuationDiskSourceCoeffs
|
||||||
{
|
{
|
||||||
fieldName U; // name of field to apply source
|
fields (U); // names of fields to apply source
|
||||||
diskDir (-1 0 0); // disk direction
|
diskDir (-1 0 0); // disk direction
|
||||||
Cp 0.1; // power coefficient
|
Cp 0.1; // power coefficient
|
||||||
Ct 0.5; // thrust coefficient
|
Ct 0.5; // thrust coefficient
|
||||||
|
|||||||
Reference in New Issue
Block a user