Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
forces Class Reference

This function object calculates the forces and moments by integrating the pressure and skin-friction forces over a given list of patches. More...

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

Public Member Functions

 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 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...
 
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

wordList createFileNames (const dictionary &dict) const
 Create file names for forces and bins. More...
 
virtual void writeFileHeader (const label i)
 Output file header information. 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...
 

Protected Attributes

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...
 

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...
 

Detailed Description

This function object calculates the forces and moments by integrating the pressure and skin-friction forces over a given list of patches.

Member function forces::write() calculates the forces/moments and writes the forces/moments into the file <timeDir>/forces.dat and bin data (if selected) to the file <timeDir>/forces_bin.dat

Example of function object specification:

forces1
{
    type        forces;
    functionObjectLibs ("libforces.so");
    ...
    log         yes;
    patches     (walls);

    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
pName pressure field name no p
UName velocity field name no U
rhoName density field name (see below) no rho
CofR centre of rotation (see below) no
directForceDensity force density supplied directly (see below) no no
fDName name of force density field (see below) no fD

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
Note
  • For incompressible cases, set rhoName to rhoInf. You will then be required to provide a rhoInf value corresponding to the free-stream constant density.
  • If the force density is supplied directly, set the directForceDensity flag to 'yes', and supply the force density field using the fDName entry
  • The centre of rotation (CofR) for moment calculations can either be specified by an CofR entry, or be taken from origin of the local coordinate system. For example,
        CofR        (0 0 0);
    
    or
        coordinateSystem
        {
            origin  (0 0 0);
            e3      (0 0 1);
            e1      (1 0 0);
        }
    
See also
Foam::functionObject Foam::OutputFilterFunctionObject Foam::forceCoeffs
Source files

Definition at line 206 of file forces.H.

Constructor & Destructor Documentation

forces ( const forces )
protected

Disallow default bitwise copy construct.

Referenced by SprayParcel< ParcelType >::calcBreakup(), KinematicParcel< ParcelType >::calcVelocity(), forces::forces(), and forces::writeBins().

Here is the caller graph for this function:

forces ( const word name,
const objectRegistry obr,
const dictionary dict,
const bool  loadFromFiles = false,
const bool  readFields = true 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 517 of file forces.C.

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

Here is the call graph for this function:

forces ( const word name,
const objectRegistry obr,
const labelHashSet patchSet,
const word pName,
const word UName,
const word rhoName,
const scalar  rhoInf,
const scalar  pRef,
const coordinateSystem coordSys 
)

Construct from components.

Definition at line 580 of file forces.C.

References forAll.

~forces ( )
virtual

Destructor.

Definition at line 628 of file forces.C.

Member Function Documentation

Foam::wordList createFileNames ( const dictionary dict) const
protected

Create file names for forces and bins.

Definition at line 46 of file forces.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), dictionary::found(), dictionary::lookup(), Foam::readLabel(), and dictionary::subDict().

Here is the call graph for this function:

void writeFileHeader ( const label  i)
protectedvirtual

Output file header information.

Reimplemented from functionObjectFile.

Reimplemented in forceCoeffs.

Definition at line 68 of file forces.C.

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

Here is the call graph for this function:

void initialise ( )
protected

Initialise the fields.

Definition at line 156 of file forces.C.

References Foam::endl(), Foam::Info, Foam::nl, and WarningIn.

Here is the call graph for this function:

Foam::tmp< Foam::volSymmTensorField > devRhoReff ( ) const
protected
Foam::tmp< Foam::volScalarField > mu ( ) const
protected

Dynamic viscosity field.

Definition at line 267 of file forces.C.

References dictionaryName::dictName(), Foam::exit(), Foam::FatalError, FatalErrorIn, dictionary::lookup(), fluidThermo::mu(), transportModel::nu(), nu, GeometricField< scalar, fvPatchField, volMesh >::null(), and rho.

Here is the call graph for this function:

Foam::tmp< Foam::volScalarField > rho ( ) const
protected

Return rho if rhoName is specified otherwise rhoRef.

Definition at line 306 of file forces.C.

References Foam::dimDensity, mesh, fvMesh::time(), and Time::timeName().

Here is the call graph for this function:

Foam::scalar rho ( const volScalarField p) const
protected

Return rhoRef if the pressure field is dynamic, i.e. p/rho.

otherwise return 1

Definition at line 334 of file forces.C.

References forces::applyBins(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimPressure, Foam::exit(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

void applyBins ( const vectorField Md,
const vectorField fN,
const vectorField fT,
const vectorField fP,
const vectorField d 
)
protected

Accumulate bin data.

Definition at line 355 of file forces.C.

References forAll, Foam::max(), Foam::min(), and Foam::sum().

Referenced by forces::rho().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeForces ( )
protected

Helper function to write force data.

Definition at line 391 of file forces.C.

References Foam::endl(), Foam::Info, Foam::nl, Foam::setw(), Foam::sum(), Foam::tab, and Foam::type().

Here is the call graph for this function:

void writeBins ( )
protected

Helper function to write bin data.

Definition at line 435 of file forces.C.

References Foam::endl(), f(), forAll, forces::forces(), Foam::setw(), List< T >::size(), and Foam::tab.

Here is the call graph for this function:

void operator= ( const forces )
protected

Disallow default bitwise assignment.

TypeName ( "forces"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of forces.

Definition at line 383 of file forces.H.

References forces::calcForcesMoment(), forces::end(), forces::execute(), forces::forceEff(), forces::momentEff(), forces::name_, forces::read(), forces::timeSet(), and forces::write().

Here is the call graph for this function:

void read ( const dictionary dict)
virtual
void execute ( )
virtual

Execute, currently does nothing.

Reimplemented in forceCoeffs.

Definition at line 769 of file forces.C.

Referenced by forces::name().

Here is the caller graph for this function:

void end ( )
virtual

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

Reimplemented in forceCoeffs.

Definition at line 775 of file forces.C.

Referenced by forces::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

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

Reimplemented in forceCoeffs.

Definition at line 781 of file forces.C.

Referenced by forces::name().

Here is the caller graph for this function:

void write ( )
virtual

Write the forces.

Reimplemented from functionObjectFile.

Reimplemented in forceCoeffs.

Definition at line 787 of file forces.C.

References Foam::endl(), Foam::Info, UPstream::master(), and functionObjectFile::write().

Referenced by forces::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void calcForcesMoment ( )
virtual
Foam::vector forceEff ( ) const
virtual

Return the total force.

Definition at line 954 of file forces.C.

References Foam::sum().

Referenced by forces::name(), sixDoFRigidBodyMotionSolver::solve(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::vector momentEff ( ) const
virtual

Return the total moment.

Definition at line 960 of file forces.C.

References Foam::sum().

Referenced by forces::name(), sixDoFRigidBodyMotionSolver::solve(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 413 of file forces.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 417 of file forces.H.

Member Data Documentation

word name_
protected

Name of this set of forces,.

Also used as the name of the probes directory.

Definition at line 216 of file forces.H.

Referenced by forces::name().

const objectRegistry& obr_
protected

Definition at line 218 of file forces.H.

bool active_
protected

On/off switch.

Definition at line 221 of file forces.H.

Switch log_
protected

Switch to send output to Info as well as to file.

Definition at line 224 of file forces.H.

List<Field<vector> > force_
protected

Pressure, viscous and porous force per bin.

Definition at line 227 of file forces.H.

List<Field<vector> > moment_
protected

Pressure, viscous and porous moment per bin.

Definition at line 230 of file forces.H.

labelHashSet patchSet_
protected

Patches to integrate forces over.

Definition at line 236 of file forces.H.

word pName_
protected

Name of pressure field.

Definition at line 239 of file forces.H.

word UName_
protected

Name of velocity field.

Definition at line 242 of file forces.H.

word rhoName_
protected

Name of density field (optional)

Definition at line 245 of file forces.H.

Switch directForceDensity_
protected

Is the force density being supplied directly?

Definition at line 248 of file forces.H.

word fDName_
protected

The name of the force density (fD) field.

Definition at line 251 of file forces.H.

scalar rhoRef_
protected

Reference density needed for incompressible calculations.

Definition at line 254 of file forces.H.

scalar pRef_
protected

Reference pressure.

Definition at line 257 of file forces.H.

coordinateSystem coordSys_
protected

Coordinate system used when evaluting forces/moments.

Definition at line 260 of file forces.H.

bool localSystem_
protected

Flag to indicate whether we are using a local co-ordinate sys.

Definition at line 263 of file forces.H.

bool porosity_
protected

Flag to include porosity effects.

Definition at line 266 of file forces.H.

label nBin_
protected

Number of bins.

Definition at line 272 of file forces.H.

vector binDir_
protected

Direction used to determine bin orientation.

Definition at line 275 of file forces.H.

scalar binDx_
protected

Distance between bin divisions.

Definition at line 278 of file forces.H.

scalar binMin_
protected

Minimum bin bounds.

Definition at line 281 of file forces.H.

List<point> binPoints_
protected

Bin positions along binDir.

Definition at line 284 of file forces.H.

bool binCumulative_
protected

Should bin data be cumulative?

Definition at line 287 of file forces.H.

bool initialised_
protected

Initialised flag.

Definition at line 291 of file forces.H.


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