Public Member Functions | Protected Member Functions | List of all members
forceCoeffs Class Reference

This function object extends the Foam::forces function object by providing lift, drag and moment coefficients. The data can optionally be output into bins, defined in a given direction. More...

Inheritance diagram for forceCoeffs:
Inheritance graph
[legend]
Collaboration diagram for forceCoeffs:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("forceCoeffs")
 Runtime type information. More...
 
 forceCoeffs (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~forceCoeffs ()
 Destructor. More...
 
virtual void read (const dictionary &)
 Read the forces data. More...
 
virtual void execute ()
 Execute, currently does nothing. More...
 
virtual void end ()
 Execute at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void write ()
 Write the forces. More...
 
- Public Member Functions inherited from forces
 TypeName ("forces")
 Runtime type information. More...
 
 forces (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false, const bool readFields=true)
 Construct for given objectRegistry and dictionary. More...
 
 forces (const word &name, const objectRegistry &, const labelHashSet &patchSet, const word &pName, const word &UName, const word &rhoName, const scalar rhoInf, const scalar pRef, const coordinateSystem &coordSys)
 Construct from components. More...
 
virtual ~forces ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of forces. More...
 
virtual void calcForcesMoment ()
 Calculate the forces and moments. More...
 
virtual vector forceEff () const
 Return the total force. More...
 
virtual vector momentEff () const
 Return the total moment. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for changes of mesh. More...
 
- Public Member Functions inherited from functionObjectFile
 functionObjectFile (const objectRegistry &obr, const word &prefix)
 Construct null. More...
 
 functionObjectFile (const objectRegistry &obr, const word &prefix, const word &name)
 Construct from components. More...
 
 functionObjectFile (const objectRegistry &obr, const word &prefix, const wordList &names)
 Construct from components. More...
 
virtual ~functionObjectFile ()
 Destructor. More...
 
const wordListnames () const
 Return const access to the names. More...
 
OFstreamfile ()
 Return access to the file (if only 1) More...
 
PtrList< OFstream > & files ()
 Return access to the files. More...
 
OFstreamfile (const label i)
 Return file 'i'. 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...
 
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...
 

Protected Member Functions

virtual void writeFileHeader (const label i)
 Output file header information. More...
 
- Protected Member Functions inherited from forces
wordList createFileNames (const dictionary &dict) const
 Create file names for forces and bins. More...
 
void initialise ()
 Initialise the fields. More...
 
tmp< volSymmTensorFielddevRhoReff () const
 Return the effective viscous stress (laminar + turbulent). More...
 
tmp< volScalarFieldmu () const
 Dynamic viscosity field. More...
 
tmp< volScalarFieldrho () const
 Return rho if rhoName is specified otherwise rhoRef. More...
 
scalar rho (const volScalarField &p) const
 Return rhoRef if the pressure field is dynamic, i.e. p/rho. More...
 
void applyBins (const vectorField &Md, const vectorField &fN, const vectorField &fT, const vectorField &fP, const vectorField &d)
 Accumulate bin data. More...
 
void writeForces ()
 Helper function to write force data. More...
 
void writeBins ()
 Helper function to write bin data. More...
 
 forces (const forces &)
 Disallow default bitwise copy construct. More...
 
void operator= (const forces &)
 Disallow default bitwise assignment. More...
 
- Protected Member Functions inherited from functionObjectFile
virtual void initStream (Ostream &os) const
 Initialise the output stream for writing. More...
 
virtual fileName baseFileDir () const
 Return the base directory for output. More...
 
virtual fileName baseTimeDir () const
 Return the base directory for the current time value. More...
 
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...
 
virtual Omanip< int > valueWidth (const label offset=0) const
 Return the value width when writing to stream with optional offset. More...
 
 functionObjectFile (const functionObjectFile &)
 Disallow default bitwise copy construct. More...
 
void operator= (const functionObjectFile &)
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Attributes inherited from functionObjectFile
static const word outputPrefix = "postProcessing"
 Directory prefix. More...
 
static label addChars = 7
 Additional characters for writing. More...
 
- Protected Attributes inherited from forces
word name_
 Name of this set of forces,. More...
 
const objectRegistryobr_
 
bool active_
 On/off switch. More...
 
Switch log_
 Switch to send output to Info as well as to file. More...
 
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...
 
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...
 
coordinateSystem coordSys_
 Coordinate system used when evaluting forces/moments. More...
 
bool localSystem_
 Flag to indicate whether we are using a local co-ordinate sys. 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< pointbinPoints_
 Bin positions along binDir. More...
 
bool binCumulative_
 Should bin data be cumulative? More...
 
bool initialised_
 Initialised flag. More...
 

Detailed Description

This function object extends the Foam::forces function object 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;
    functionObjectLibs ("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;
    }
}


Function object usage

Property Description Required Default value
type type name: forces 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 picth 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 incresing distance yes
See also
Foam::functionObject Foam::OutputFilterFunctionObject Foam::forces
Source files

Definition at line 171 of file forceCoeffs.H.

Constructor & Destructor Documentation

forceCoeffs ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 123 of file forceCoeffs.C.

References Foam::endl(), Foam::Info, and Foam::read().

Here is the call graph for this function:

~forceCoeffs ( )
virtual

Destructor.

Definition at line 146 of file forceCoeffs.C.

Member Function Documentation

void writeFileHeader ( const label  i)
protectedvirtual

Output file header information.

Reimplemented from forces.

Definition at line 42 of file forceCoeffs.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorIn, forAll, Foam::jn(), Foam::name(), Foam::nl, and Foam::tab.

Here is the call graph for this function:

TypeName ( "forceCoeffs"  )

Runtime type information.

void read ( const dictionary dict)
virtual

Read the forces data.

Reimplemented from forces.

Definition at line 152 of file forceCoeffs.C.

References dictionary::lookup(), and forces::read().

Here is the call graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Reimplemented from forces.

Definition at line 173 of file forceCoeffs.C.

void end ( )
virtual

Execute at the final time-loop, currently does nothing.

Reimplemented from forces.

Definition at line 179 of file forceCoeffs.C.

void timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Reimplemented from forces.

Definition at line 185 of file forceCoeffs.C.

void write ( )
virtual

Write the forces.

Reimplemented from forces.

Definition at line 191 of file forceCoeffs.C.

References forces::calcForcesMoment(), Foam::endl(), forAll, Foam::Info, UPstream::master(), Foam::nl, pDyn(), List< T >::setSize(), List< T >::size(), Foam::sum(), Foam::tab, Foam::type(), and functionObjectFile::write().

Here is the call graph for this function:


The documentation for this class was generated from the following files: