Computes forces and moments over a given list of patches by integrating pressure and viscous forces and moments, and optionally resistance forces and moments from porous zones. More...

Inheritance diagram for forces:

[legend]

Collaboration diagram for forces:

[legend]

Public Member Functions
	TypeName ("forces")
	Runtime type information. More...

	forces (const word &name, const Time &runTime, const dictionary &dict, const bool readFields=true)
	Construct from Time and dictionary. More...

	forces (const word &name, const objectRegistry &obr, const dictionary &dict, const bool readFields=true)
	Construct from objectRegistry and dictionary. More...

	forces (const forces &)=delete
	No copy construct. More...

void	operator= (const forces &)=delete
	No copy assignment. More...

virtual	~forces ()=default
	Destructor. More...

virtual bool	read (const dictionary &dict)
	Read the dictionary. More...

virtual void	calcForcesMoments ()
	Calculate forces and moments. More...

virtual vector	forceEff () const
	Return the total force. More...

virtual vector	momentEff () const
	Return the total moment. More...

virtual bool	execute ()
	Execute the function object. More...

virtual bool	write ()
	Write to data files/fields and to streams. 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...

virtual	~fvMeshFunctionObject ()=default
	Destructor. 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...

virtual	~regionFunctionObject ()=default
	Destructor. More...

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri)
	Set new trigger index. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time. More...

const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time. More...

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

virtual	~functionObject ()=default
	Destructor. More...

virtual const word &	type () const =0
	Runtime type information. More...

const word &	name () const noexcept
	Return the name of this functionObject. More...

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true)
	Construct from objectRegistry, prefix, fileName. More...

	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true)
	Construct from objectRegistry, prefix, fileName and read options from dictionary. More...

	writeFile (const writeFile &wf)
	Construct copy. More...

virtual	~writeFile ()=default
	Destructor. More...

virtual OFstream &	file ()
	Return access to the file (if only 1) More...

virtual bool	writeToFile () const
	Flag to allow writing to file. More...

virtual bool	canWriteToFile () const
	Flag to allow writing to the file. More...

virtual bool	canResetFile () const
	Flag to allow resetting the file. More...

virtual bool	canWriteHeader () const
	Flag to allow writing the header. More...

virtual label	charWidth () const
	Return width of character stream output. More...

virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream. More...

virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream. More...

virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream. More...

virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream. More...

virtual void	writeBreak (Ostream &os) const
	Write a break marker to the 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...

template<class Type >
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter. More...

Protected Member Functions
void	setCoordinateSystem (const dictionary &dict, const word &e3Name=word::null, const word &e1Name=word::null)
	Set the co-ordinate system from dictionary and axes names. More...

volVectorField &	force ()
	Return access to the force field. More...

volVectorField &	moment ()
	Return access to the moment field. More...

void	initialise ()
	Initialise containers and fields. More...

void	reset ()
	Reset containers and fields. More...

tmp< symmTensorField >	devRhoReff (const tensorField &gradUp, const label patchi) const
	Return the effective stress (viscous + turbulent) for patch. More...

tmp< volScalarField >	mu () const
	Return dynamic viscosity field. More...

tmp< volScalarField >	rho () const
	Return rho if specified otherwise rhoRef. More...

tmp< scalarField >	rho (const label patchi) const
	Return rho if specified otherwise rhoRef for patch. More...

scalar	rho (const volScalarField &p) const
	Return rhoRef if the pressure field is dynamic (i.e. p/rho), otherwise return 1. More...

void	addToPatchFields (const label patchi, const vectorField &Md, const vectorField &fP, const vectorField &fV)
	Add patch contributions to force and moment fields. More...

void	addToInternalField (const labelList &cellIDs, const vectorField &Md, const vectorField &f)
	Add cell contributions to force and moment fields, and include porosity effects. More...

void	createIntegratedDataFiles ()
	Create the integrated-data files. More...

void	writeIntegratedDataFileHeader (const word &header, OFstream &os) const
	Write header for an integrated-data file. More...

void	writeIntegratedDataFiles ()
	Write integrated data to files. More...

void	writeIntegratedDataFile (const vector &pres, const vector &vis, const vector &internal, OFstream &os) const
	Write integrated data to a file. More...

void	logIntegratedData (const string &descriptor, const vector &pres, const vector &vis, const vector &internal) const
	Write integrated data to stream. More...

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry. More...

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the field in the (sub) objectRegistry under the given name. More...

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present. More...

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Member Functions inherited from writeFile
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...

fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name. More...

virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name. More...

virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time. More...

virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name. More...

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. More...

void	operator= (const writeFile &)=delete
	No copy assignment. More...

virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time. More...

Protected Attributes
vector	sumPatchForcesP_
	Sum of patch pressure forces. More...

vector	sumPatchForcesV_
	Sum of patch viscous forces. More...

vector	sumPatchMomentsP_
	Sum of patch pressure moments. More...

vector	sumPatchMomentsV_
	Sum of patch viscous moments. More...

vector	sumInternalForces_
	Sum of internal forces. More...

vector	sumInternalMoments_
	Sum of internal moments. More...

autoPtr< OFstream >	forceFilePtr_
	File stream for forces. More...

autoPtr< OFstream >	momentFilePtr_
	File stream for moments. More...

autoPtr< coordinateSystem >	coordSysPtr_
	Coordinate system used when evaluating forces and moments. More...

labelHashSet	patchSet_
	Names of operand patches. More...

scalar	rhoRef_
	Reference density needed for incompressible calculations. More...

scalar	pRef_
	Reference pressure. More...

word	pName_
	Name of pressure field. More...

word	UName_
	Name of velocity field. More...

word	rhoName_
	Name of density field. More...

word	fDName_
	Name of force density field. More...

bool	directForceDensity_
	Flag to directly supply force density. More...

bool	porosity_
	Flag to include porosity effects. More...

bool	writeFields_
	Flag to write force and moment fields. More...

bool	initialised_
	Flag of initialisation (internal) More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const fileName	prefix_
	Prefix. More...

word	fileName_
	Name of file. More...

autoPtr< OFstream >	filePtr_
	File pointer. More...

label	writePrecision_
	Write precision. More...

bool	writeToFile_
	Flag to enable/disable writing to file. More...

bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true. More...

bool	writtenHeader_
	Flag to identify whether the header has been written. More...

bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true. More...

scalar	startTime_
	Start time value. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing. More...

Detailed Description

Computes forces and moments over a given list of patches by integrating pressure and viscous forces and moments, and optionally resistance forces and moments from porous zones.

Forces and moments are output in their total and constituent components:

total forces and moments
pressure contributions
viscous contributions
porous resistance contributions (optional)

Forces and moments can be computed and output in:

the global Cartesian coordinate system (default)
a user-defined Cartesian coordinate system

Operands:

Operand	Type	Location
`input`	-	-
`output` file	dat	postProcessing/<FO>/<time>/<file>s
`output` field	volVectorField	<time>/<outField>s

where <file>s:

      force.dat        | Forces
      moment.dat       | Moments

where <outField>s:

      <namePrefix>:force   | Force field
      <namePrefix>:moment  | Moment field

Usage

Minimal example by using system/controlDict.functions:

<namePrefix>
{
    // Mandatory entries
    type                forces;
    libs                (forces);
    patches             (<wordRes>);

    // Optional entries
    directForceDensity  <bool>;
    porosity            <bool>;
    writeFields         <bool>;
    useNamePrefix       <bool>;

    // Conditional mandatory entries

        // if directForceDensity == true
        fD              <word>;


        // Cartesian coordinate system specification when
        // evaluating forces and moments, either of the below

        // Define the centre of rotation
        // with implicit directions e1=(1 0 0) and e3=(0 0 1)
        CofR                (0 0 0); // Centre of rotation

        // Define local coordinate system by origin + axes
        origin              (0 0 0);
        e1                  (1 0 0);
        e3                  (0 0 1); // (e1, e2) or (e2, e3) or (e3, e1)

        // General coordinate system specification (always cartesian)
        coordinateSystem
        {
            origin          (0 0 0);
            rotation
            {
                type        axes;
                e3          (0 0 1);
                e1          (1 0 0); // (e1, e2) or (e2, e3) or (e3, e1)
            }
        }

    // Conditional optional entries

        // if directForceDensity == false
        p               <word>;
        U               <word>;
        rho             <word>;
        rhoInf          <scalar>; // enabled if rho=rhoInf
        pRef            <scalar>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: forces	word	yes	-
`libs`	Library name: forces	word	yes	-
`patches`	Names of operand patches	wordRes	yes	-
`directForceDensity`	Flag to directly supply force density	bool	no	false
`porosity`	Flag to include porosity contributions	bool	no	false
`writeFields`	Flag to write force and moment fields	bool	no	false
`useNamePrefix`	Flag to include prefix for field names	bool	no	false
`coordinateSystem`	Coordinate system specifier	dictionary	cndtnl	-
`CofR`	Centre of rotation	vector	cndtnl	-
`origin`	Origin of coordinate system	vector	cndtnl	-
`e3`	e3 coordinate axis	vector	cndtnl	-
`e1`	e1 coordinate axis	vector	cndtnl	-
`fD`	Name of force density field	word	cndtnl	-
`p`	Name of pressure field	word	cndtnl	p
`U`	Name of velocity field	word	cndtnl	U
`rho`	Name of density field	word	cndtnl	rho
`rhoInf`	Value of reference density	scalar	cndtnl	-
`pRef`	Value of reference pressure	scalar	cndtnl	0

The inherited entries are elaborated in:

Note

For incompressible cases, set rho to rhoInf. You will then be required to provide a rhoInf value corresponding to the constant freestream density.
writeControl and writeInterval entries of function object do control when to output force and moment files and fields.
If a coordinateSystem entry exists, it is taken in favour of CofR.

Source files

Definition at line 317 of file forces.H.

Constructor & Destructor Documentation

◆ forces() [1/3]

forces	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const bool	readFields = `true`
	)

Construct from Time and dictionary.

Definition at line 523 of file forces.C.

References dict, Foam::endl(), Log, and Foam::read().

Here is the call graph for this function:

◆ forces() [2/3]

forces	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	readFields = `true`
	)

Construct from objectRegistry and dictionary.

Definition at line 563 of file forces.C.

References dict, Foam::endl(), Log, and Foam::read().

Here is the call graph for this function:

◆ forces() [3/3]

forces ( const forces & )

delete

No copy construct.

◆ ~forces()

virtual ~forces ( )

virtualdefault

Destructor.

Member Function Documentation

◆ setCoordinateSystem()

void setCoordinateSystem	(	const dictionary &	dict,
		const word &	e3Name = `word::null`,
		const word &	e1Name = `word::null`
	)

protected

Set the co-ordinate system from dictionary and axes names.

Definition at line 45 of file forces.C.

References dict, and Foam::Zero.

◆ force()

Foam::volVectorField & force ( )

protected

Return access to the force field.

Definition at line 83 of file forces.C.

References Foam::dimForce, objectRegistry::getObjectPtr(), fvMeshFunctionObject::mesh_, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, IOobjectOption::REGISTER, functionObject::scopedName(), timeFunctionObject::time_, Time::timeName(), and Foam::Zero.

Here is the call graph for this function:

◆ moment()

Foam::volVectorField & moment ( )

protected

Return access to the moment field.

Definition at line 111 of file forces.C.

References Foam::dimForce, Foam::dimLength, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, IOobjectOption::REGISTER, and Foam::Zero.

◆ initialise()

void initialise ( )

protected

Initialise containers and fields.

Definition at line 139 of file forces.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and initialised_().

Here is the call graph for this function:

◆ reset()

void reset ( )

protected

Reset containers and fields.

Definition at line 181 of file forces.C.

References dimensioned< Type >::dimensions(), and Foam::Zero.

Here is the call graph for this function:

◆ devRhoReff()

Foam::tmp< Foam::symmTensorField > devRhoReff	(	const tensorField &	gradUp,
		const label	patchi
	)		const

protected

Return the effective stress (viscous + turbulent) for patch.

Definition at line 213 of file forces.C.

References Foam::devTwoSymm(), dictionary::dictName(), Foam::dimViscosity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, nu, GeometricField< symmTensor, fvPatchField, volMesh >::null(), rho, transportProperties(), and turb.

Here is the call graph for this function:

◆ mu()

Foam::tmp< Foam::volScalarField > mu ( ) const

protected

Return dynamic viscosity field.

Definition at line 268 of file forces.C.

References dictionary::dictName(), Foam::dimViscosity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, nu, GeometricField< scalar, fvPatchField, volMesh >::null(), rho, and transportProperties().

Here is the call graph for this function:

◆ rho() [1/3]

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

protected

Return rho if specified otherwise rhoRef.

Definition at line 303 of file forces.C.

References Foam::dimDensity, and tmp< T >::New().

Here is the call graph for this function:

◆ rho() [2/3]

Foam::tmp< Foam::scalarField > rho ( const label patchi ) const

protected

Return rho if specified otherwise rhoRef for patch.

Definition at line 325 of file forces.C.

References tmp< T >::New(), and rho.

Here is the call graph for this function:

◆ rho() [3/3]

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 341 of file forces.C.

References Foam::dimPressure, Foam::exit(), Foam::FatalError, FatalErrorInFunction, and p.

Here is the call graph for this function:

◆ addToPatchFields()

void addToPatchFields	(	const label	patchi,
		const vectorField &	Md,
		const vectorField &	fP,
		const vectorField &	fV
	)

protected

Add patch contributions to force and moment fields.

Definition at line 360 of file forces.C.

References Foam::sum().

Here is the call graph for this function:

◆ addToInternalField()

void addToInternalField	(	const labelList &	cellIDs,
		const vectorField &	Md,
		const vectorField &	f
	)

protected

Add cell contributions to force and moment fields, and include porosity effects.

Definition at line 383 of file forces.C.

References cellIDs, f(), and forAll.

Here is the call graph for this function:

◆ createIntegratedDataFiles()

void createIntegratedDataFiles ( )

protected

Create the integrated-data files.

Definition at line 406 of file forces.C.

◆ writeIntegratedDataFileHeader()

void writeIntegratedDataFileHeader	(	const word &	header,
		OFstream &	os
	)		const

protected

Write header for an integrated-data file.

Definition at line 423 of file forces.C.

References Foam::endl(), os(), and Foam::writeHeader().

Here is the call graph for this function:

◆ writeIntegratedDataFiles()

void writeIntegratedDataFiles ( )

protected

Write integrated data to files.

Definition at line 450 of file forces.C.

◆ writeIntegratedDataFile()

void writeIntegratedDataFile	(	const vector &	pres,
		const vector &	vis,
		const vector &	internal,
		OFstream &	os
	)		const

protected

Write integrated data to a file.

Definition at line 473 of file forces.C.

References Foam::endl(), and os().

Here is the call graph for this function:

◆ logIntegratedData()

void logIntegratedData	(	const string &	descriptor,
		const vector &	pres,
		const vector &	vis,
		const vector &	internal
	)		const

protected

Write integrated data to stream.

Definition at line 496 of file forces.C.

References Log, and Foam::nl.

◆ TypeName()

TypeName ( "forces" )

Runtime type information.

◆ operator=()

void operator= ( const forces & )

delete

No copy assignment.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the dictionary.

Reimplemented from writeFile.

Reimplemented in forceCoeffs, and propellerInfo.

Definition at line 604 of file forces.C.

References dict, Foam::endl(), MinMax< scalar >::ge(), Foam::Info, initialised_(), Foam::name(), regionFunctionObject::read(), writeFile::read(), and Foam::type().

Referenced by propellerInfo::read(), and forceCoeffs::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcForcesMoments()

void calcForcesMoments ( )

virtual

Calculate forces and moments.

Definition at line 681 of file forces.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Foam::endl(), forAllConstIters(), Foam::fvc::grad(), Foam::constant::physicoChemical::mu, p, Foam::reduce(), rho, U, and WarningInFunction.

Referenced by forceCoeffs::execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ forceEff()

Foam::vector forceEff ( ) const

virtual

Return the total force.

Definition at line 796 of file forces.C.

◆ momentEff()

Foam::vector momentEff ( ) const

virtual

Return the total moment.

Definition at line 802 of file forces.C.

◆ execute()

bool execute ( )

virtual

Execute the function object.

Implements functionObject.

Reimplemented in forceCoeffs, and propellerInfo.

Definition at line 808 of file forces.C.

References Log, Foam::name(), Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write to data files/fields and to streams.

Implements functionObject.

Reimplemented in forceCoeffs, and propellerInfo.

Definition at line 839 of file forces.C.

References Foam::endl(), Log, and Ostream::write().

Here is the call graph for this function:

Member Data Documentation

◆ sumPatchForcesP_

vector sumPatchForcesP_

protected

Sum of patch pressure forces.

Definition at line 331 of file forces.H.

◆ sumPatchForcesV_

vector sumPatchForcesV_

protected

Sum of patch viscous forces.

Definition at line 336 of file forces.H.

◆ sumPatchMomentsP_

vector sumPatchMomentsP_

protected

Sum of patch pressure moments.

Definition at line 341 of file forces.H.

◆ sumPatchMomentsV_

vector sumPatchMomentsV_

protected

Sum of patch viscous moments.

Definition at line 346 of file forces.H.

◆ sumInternalForces_

vector sumInternalForces_

protected

Sum of internal forces.

Definition at line 351 of file forces.H.

◆ sumInternalMoments_

vector sumInternalMoments_

protected

Sum of internal moments.

Definition at line 356 of file forces.H.

◆ forceFilePtr_

autoPtr<OFstream> forceFilePtr_

protected

File stream for forces.

Definition at line 364 of file forces.H.

◆ momentFilePtr_

autoPtr<OFstream> momentFilePtr_

protected

File stream for moments.

Definition at line 369 of file forces.H.

◆ coordSysPtr_

autoPtr<coordinateSystem> coordSysPtr_

protected

Coordinate system used when evaluating forces and moments.

Definition at line 377 of file forces.H.

◆ patchSet_

labelHashSet patchSet_

protected

Names of operand patches.

Definition at line 382 of file forces.H.

◆ rhoRef_

scalar rhoRef_

protected

Reference density needed for incompressible calculations.

Definition at line 387 of file forces.H.

◆ pRef_

scalar pRef_

protected

Reference pressure.

Definition at line 392 of file forces.H.

◆ pName_

word pName_

protected

Name of pressure field.

Definition at line 397 of file forces.H.

◆ UName_

word UName_

protected

Name of velocity field.

Definition at line 402 of file forces.H.

◆ rhoName_

word rhoName_

protected

Name of density field.

Definition at line 407 of file forces.H.

◆ fDName_

word fDName_

protected

Name of force density field.

Definition at line 412 of file forces.H.

◆ directForceDensity_

bool directForceDensity_

protected

Flag to directly supply force density.

Definition at line 417 of file forces.H.

◆ porosity_

bool porosity_

protected

Flag to include porosity effects.

Definition at line 422 of file forces.H.

◆ writeFields_

bool writeFields_

protected

Flag to write force and moment fields.

Definition at line 427 of file forces.H.

◆ initialised_

bool initialised_

protected

Flag of initialisation (internal)

Definition at line 432 of file forces.H.

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

src/functionObjects/forces/forces/forces.H
src/functionObjects/forces/forces/forces.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ forces() [1/3]

◆ forces() [2/3]

◆ forces() [3/3]

◆ ~forces()

Member Function Documentation

◆ setCoordinateSystem()

◆ force()

◆ moment()

◆ initialise()

◆ reset()

◆ devRhoReff()

◆ mu()

◆ rho() [1/3]

◆ rho() [2/3]

◆ rho() [3/3]

◆ addToPatchFields()

◆ addToInternalField()

◆ createIntegratedDataFiles()

◆ writeIntegratedDataFileHeader()

◆ writeIntegratedDataFiles()

◆ writeIntegratedDataFile()

◆ logIntegratedData()

◆ TypeName()

◆ operator=()

◆ read()

◆ calcForcesMoments()

◆ forceEff()

◆ momentEff()

◆ execute()

◆ write()

Member Data Documentation

◆ sumPatchForcesP_

◆ sumPatchForcesV_

◆ sumPatchMomentsP_

◆ sumPatchMomentsV_

◆ sumInternalForces_

◆ sumInternalMoments_

◆ forceFilePtr_

◆ momentFilePtr_

◆ coordSysPtr_

◆ patchSet_

◆ rhoRef_

◆ pRef_

◆ pName_

◆ UName_

◆ rhoName_

◆ fDName_

◆ directForceDensity_

◆ porosity_

◆ writeFields_

◆ initialised_