Extends the forces functionObject by providing lift, drag and moment coefficients. The data can optionally be output into bins, defined in a given direction. More...
Public Member Functions | |
TypeName ("forceCoeffs") | |
Runtime type information. More... | |
forceCoeffs (const word &name, const Time &runTime, const dictionary &) | |
Construct from Time and dictionary. More... | |
forceCoeffs (const forceCoeffs &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~forceCoeffs () |
Destructor. More... | |
virtual bool | read (const dictionary &) |
Read the forces data. More... | |
virtual bool | execute () |
Execute, currently does nothing. More... | |
virtual bool | write () |
Write the forces. More... | |
void | operator= (const forceCoeffs &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from forces | |
TypeName ("forces") | |
Runtime type information. More... | |
forces (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
forces (const word &name, const objectRegistry &obr, const dictionary &) | |
Construct from objectRegistry and dictionary. More... | |
forces (const forces &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~forces () |
Destructor. More... | |
void | operator= (const forces &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from forcesBase | |
TypeName ("forcesBase") | |
Runtime type information. More... | |
forcesBase (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
forcesBase (const word &name, const objectRegistry &obr, const dictionary &) | |
Construct from objectRegistry and dictionary. More... | |
forcesBase (const forcesBase &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~forcesBase () |
Destructor. More... | |
virtual wordList | fields () const |
Return the list of fields required. More... | |
virtual void | calcForcesMoments () |
Calculate the forces and moments. More... | |
virtual vector | forceEff () const |
Return the total force. More... | |
virtual vector | momentEff () const |
Return the total moment. More... | |
void | operator= (const forcesBase &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from fvMeshFunctionObject | |
TypeName ("fvMeshFunctionObject") | |
Runtime type information. More... | |
fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~fvMeshFunctionObject () |
Destructor. More... | |
void | operator= (const fvMeshFunctionObject &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from regionFunctionObject | |
TypeName ("regionFunctionObject") | |
Runtime type information. More... | |
regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
regionFunctionObject (const regionFunctionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~regionFunctionObject () |
Destructor. More... | |
void | operator= (const regionFunctionObject &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from functionObject | |
ClassName ("functionObject") | |
virtual const word & | type () const =0 |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict)) | |
functionObject (const word &name, const Time &runTime) | |
Construct from components. More... | |
autoPtr< functionObject > | clone () const |
Return clone. More... | |
functionObject (const functionObject &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~functionObject () |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | executeAtStart () const |
Return true if the functionObject should be executed at the start. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual scalar | timeToNextAction () |
Called by Time::adjustTimeStep(). Allows the functionObject to. More... | |
virtual scalar | maxDeltaT () const |
Return the maximum time-step for stable operation. More... | |
virtual void | movePoints (const polyMesh &mesh) |
Update topology using the given map. More... | |
virtual void | topoChange (const polyTopoChangeMap &map) |
Update topology using the given map. More... | |
virtual void | mapMesh (const polyMeshMap &) |
Update from another mesh using the given map. More... | |
virtual void | distribute (const polyDistributionMap &) |
Redistribute or update using the given distribution map. More... | |
void | operator= (const functionObject &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from logFiles | |
logFiles (const objectRegistry &obr, const word &prefix) | |
Construct from objectRegistry and prefix. More... | |
logFiles (const logFiles &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~logFiles () |
Destructor. More... | |
const wordList & | toc () const |
Return the list of log file names. More... | |
const wordList & | names () const |
Return the list of log file names. More... | |
PtrList< OFstream > & | files () |
Return access to the files. More... | |
OFstream & | file () |
Return access to the file (if only 1) More... | |
OFstream & | file (const label i) |
Return file 'i'. More... | |
void | operator= (const logFiles &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from writeFile | |
writeFile (const objectRegistry &obr, const word &prefix) | |
Construct from objectRegistry and prefix. More... | |
writeFile (const writeFile &)=delete | |
Disallow default bitwise copy construction. More... | |
~writeFile () | |
Destructor. More... | |
void | initStream (Ostream &os) const |
Initialise the output stream for writing. More... | |
fileName | baseFileDir () const |
Return the base directory for output. More... | |
fileName | baseTimeDir () const |
Return the base directory for the current time value. More... | |
Omanip< int > | valueWidth (const label offset=0) const |
Return the value width when writing to stream with optional offset. More... | |
void | writeCommented (Ostream &os, const string &str) const |
Write a commented string to stream. More... | |
void | writeTabbed (Ostream &os, const string &str) const |
Write a tabbed string to stream. More... | |
void | writeHeader (Ostream &os, const string &str) const |
Write a commented header to stream. More... | |
void | writeTime (Ostream &os) const |
Write the current time to stream. More... | |
template<class Type > | |
void | writeHeaderValue (Ostream &os, const string &property, const Type &value) const |
Write a (commented) header property and value pair. More... | |
label | charWidth () const |
Return width of character stream output. More... | |
void | operator= (const writeFile &)=delete |
Disallow default bitwise assignment. More... | |
Protected Member Functions | |
virtual void | writeFileHeader (const label i) |
Output file header information. More... | |
Protected Member Functions inherited from forces | |
virtual vector | CofR () const |
Return the current centre of the rigid body. More... | |
virtual void | writeCoRValueHeader (Ostream &file) |
Write the constant centre of rotation value in the header. More... | |
virtual void | writeCoRHeader (Ostream &file) |
Do not write the constant centre of rotation. More... | |
virtual void | writeCofR (Ostream &file) |
Do not write the constant centre of rotation. More... | |
Protected Member Functions inherited from forcesBase | |
Ostream & | file (const fileID fid) |
wordList | createFileNames (const dictionary &dict) const |
Create file names for forces and bins. More... | |
void | initialise () |
Initialise the fields. More... | |
tmp< volSymmTensorField > | devTau () const |
Return the effective viscous stress (laminar + turbulent). More... | |
tmp< volScalarField > | mu () const |
Dynamic viscosity field. More... | |
tmp< volScalarField > | rho () const |
Return rho if specified otherwise rhoRef. More... | |
scalar | rho (const volScalarField &p) const |
Return rhoRef if the pressure field is dynamic, i.e. p/rho. More... | |
tmp< volScalarField > | alpha () const |
Get the volume fraction field. More... | |
tmp< scalarField > | alpha (const label patchi) const |
Get the volume fraction field on a patch. More... | |
void | applyBins (const vectorField &Md, const vectorField &fN, const vectorField &fT, const vectorField &fP, const vectorField &d) |
Accumulate bin data. More... | |
void | calcForcesMoments (const vector &CofR) |
Calculate the forces and moments. More... | |
void | writeForces () |
Helper function to write force data. More... | |
void | writeBins () |
Helper function to write bin data. More... | |
OFstream & | file () |
Return access to the file (if only 1) More... | |
OFstream & | file (const label i) |
Return file 'i'. More... | |
Protected Member Functions inherited from fvMeshFunctionObject | |
labelHashSet | patchSet (const dictionary &, const bool optional=false) const |
Return the patch set corresponding to the patch selection entries. More... | |
Protected Member Functions inherited from regionFunctionObject | |
template<class ObjectType > | |
bool | foundObject (const word &fieldName) const |
Find field in the objectRegistry. More... | |
template<class ObjectType > | |
void | cannotFindObject (const word &fieldName) |
Prints a warning message that fieldName cannot be found. More... | |
void | cannotFindObject (const word &fieldName) |
Prints a warning message that fieldName cannot be found. More... | |
void | cannotFindObjects (const wordList &fieldNames) |
Prints a warning message that fieldNames cannot be found. More... | |
template<class ObjectType > | |
const ObjectType & | lookupObject (const word &fieldName) const |
Lookup object from the objectRegistry. More... | |
template<class ObjectType > | |
ObjectType & | lookupObjectRef (const word &fieldName) |
Lookup non-const object reference from the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (const tmp< ObjectType > &tfield) |
Store the given field in the objectRegistry. More... | |
template<class ObjectType > | |
bool | store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false) |
Store the given field in the objectRegistry under the given name. More... | |
bool | writeObject (const word &fieldName) |
Write field if present in objectRegistry. More... | |
bool | clearObject (const word &fieldName) |
Clear field from the objectRegistry if present. More... | |
Protected Member Functions inherited from logFiles | |
virtual void | createFiles () |
Create the output file. More... | |
virtual void | resetNames (const wordList &names) |
Reset the list of names from a wordList. More... | |
virtual void | resetName (const word &name) |
Reset the list of names to a single name entry. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from functionObject | |
static autoPtr< functionObject > | New (const word &name, const Time &, const dictionary &) |
Select from dictionary, based on its "type" entry. More... | |
Public Attributes inherited from functionObject | |
Switch | log |
Switch write log to Info. More... | |
Switch | executeAtStart_ |
Switch write log to Info. More... | |
Static Public Attributes inherited from functionObject | |
static bool | postProcess |
Global post-processing mode switch. More... | |
Static Public Attributes inherited from writeFile | |
static const word | outputPrefix |
Directory prefix. More... | |
static label | addChars = 8 |
Additional characters for writing. More... | |
Protected Types inherited from forcesBase | |
enum class | fileID { mainFile = 0 , binsFile = 1 } |
Enumeration for ensuring the right file is accessed. More... | |
Protected Attributes inherited from forces | |
vector | CofR_ |
Centre of rotation. More... | |
Protected Attributes inherited from forcesBase | |
List< Field< vector > > | force_ |
Pressure, viscous and porous force per bin. More... | |
List< Field< vector > > | moment_ |
Pressure, viscous and porous moment per bin. More... | |
labelHashSet | patchSet_ |
Patches to integrate forces over. More... | |
word | pName_ |
Name of pressure field. More... | |
word | UName_ |
Name of velocity field. More... | |
word | rhoName_ |
Name of density field (optional) More... | |
word | phaseName_ |
The name of the phase (optional) More... | |
Switch | directForceDensity_ |
Is the force density being supplied directly? More... | |
word | fDName_ |
The name of the force density (fD) field. More... | |
scalar | rhoRef_ |
Reference density needed for incompressible calculations. More... | |
scalar | pRef_ |
Reference pressure. More... | |
bool | porosity_ |
Flag to include porosity effects. More... | |
label | nBin_ |
Number of bins. More... | |
vector | binDir_ |
Direction used to determine bin orientation. More... | |
scalar | binDx_ |
Distance between bin divisions. More... | |
scalar | binMin_ |
Minimum bin bounds. More... | |
List< point > | binPoints_ |
Bin positions along binDir. More... | |
bool | binCumulative_ |
Should bin data be cumulative? More... | |
bool | initialised_ |
Initialised flag. More... | |
Protected Attributes inherited from fvMeshFunctionObject | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
Protected Attributes inherited from regionFunctionObject | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
Protected Attributes inherited from functionObject | |
const Time & | time_ |
Reference to time. More... | |
Protected Attributes inherited from logFiles | |
wordList | names_ |
File names. More... | |
PtrList< OFstream > | filePtrs_ |
File pointer. More... | |
Protected Attributes inherited from writeFile | |
const objectRegistry & | fileObr_ |
Reference to the region objectRegistry. More... | |
const word | prefix_ |
Prefix. More... | |
Extends the forces functionObject by providing lift, drag and moment coefficients. The data can optionally be output into bins, defined in a given direction.
Example of function object specification:
forceCoeffs1 { type forceCoeffs; libs ("libforces.so"); ... log yes; patches (walls); liftDir (0 1 0); dragDir (-1 0 0); pitchAxis (0 0 1); magUInf 100; lRef 3.5; Aref 2.2; binData { nBin 20; direction (1 0 0); cumulative yes; } }
Property | Description | Required | Default value |
---|---|---|---|
type | type name: forceCoeffs | yes | |
log | write force data to standard output | no | no |
patches | patches included in the forces calculation | yes | |
liftDir | lift direction | yes | |
dragDir | drag direction | yes | |
pitchAxis | pitch axis | yes | |
magUInf | free stream velocity magnitude | yes | |
lRef | reference length scale for moment calculations | yes | |
Aref | reference area | yes |
Bin data is optional, but if the dictionary is present, the entries must be defined according o
nBin | number of data bins | yes | |
---|---|---|---|
direction | direction along which bins are defined | yes | |
cumulative | bin data accumulated with increasing distance | yes |
Definition at line 169 of file forceCoeffs.H.
forceCoeffs | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from Time and dictionary.
Definition at line 127 of file forceCoeffs.C.
References dict, and forceCoeffs::read().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 148 of file forceCoeffs.C.
|
protectedvirtual |
Output file header information.
Reimplemented from forcesBase.
Definition at line 43 of file forceCoeffs.C.
References Foam::abort(), forcesBase::binDir_, forcesBase::binDx_, forcesBase::binMin_, forcesBase::binsFile, forces::CofR_, Foam::endl(), Foam::FatalError, FatalErrorInFunction, forcesBase::file(), forAll, Foam::jn(), forcesBase::mainFile, Foam::name(), forcesBase::nBin_, Foam::nl, Foam::tab, writeFile::writeCommented(), writeFile::writeHeader(), writeFile::writeHeaderValue(), and writeFile::writeTabbed().
TypeName | ( | "forceCoeffs" | ) |
Runtime type information.
|
virtual |
Read the forces data.
Reimplemented from forces.
Definition at line 154 of file forceCoeffs.C.
References dict, Foam::mag(), and forces::read().
Referenced by forceCoeffs::forceCoeffs().
|
virtual |
Execute, currently does nothing.
Reimplemented from forcesBase.
Definition at line 184 of file forceCoeffs.C.
|
virtual |
Write the forces.
Reimplemented from forcesBase.
Definition at line 190 of file forceCoeffs.C.
References forcesBase::calcForcesMoments(), Foam::endl(), Foam::file, forAll, Log, UPstream::master(), Foam::name(), Foam::nl, List< T >::setSize(), List< T >::size(), Foam::sum(), Foam::tab, Foam::type(), and logFiles::write().
|
delete |
Disallow default bitwise assignment.