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

Inheritance diagram for forceCoeffs:

[legend]

Collaboration diagram for forceCoeffs:

[legend]

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

	forceCoeffs (const word &name, const Time &runTime, const dictionary &)
	Construct from Time and dictionary. 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...

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

virtual	~forces ()
	Destructor. 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...

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 ()
	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 ()
	Destructor. More...

Public Member Functions inherited from 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)
	Construct from components. More...

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

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. 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 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 logFiles
	logFiles (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. More...

virtual	~logFiles ()
	Destructor. More...

const wordList &	names () const
	Return const access to the 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...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const word &prefix)
	Construct from objectRegistry and prefix. 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...

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< volSymmTensorField >	devRhoReff () 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...

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 regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. 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 (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...

Static Public Attributes inherited from functionObject
static int	debug

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 = 7
	Additional characters for writing. More...

Protected Types inherited from forces
enum	fileID { MAIN_FILE = 0, BINS_FILE = 1 }
	Enumeration for ensuring the right file is accessed. More...

Protected Attributes inherited from forces
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< 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 Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. 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...

Detailed Description

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;
    }
}

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::functionObjects::timeControl Foam::functionObjects::forces

Source files

Definition at line 172 of file forceCoeffs.H.

Constructor & Destructor Documentation

◆ forceCoeffs()

forceCoeffs	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 128 of file forceCoeffs.C.

References Foam::read().

Here is the call graph for this function:

◆ ~forceCoeffs()

~forceCoeffs ( )

virtual

Destructor.

Definition at line 148 of file forceCoeffs.C.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( const label i )

protectedvirtual

Output file header information.

Reimplemented from forces.

Definition at line 43 of file forceCoeffs.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "forceCoeffs" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the forces data.

Reimplemented from forces.

Definition at line 154 of file forceCoeffs.C.

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

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute, currently does nothing.

Reimplemented from forces.

Definition at line 177 of file forceCoeffs.C.

◆ write()

bool write ( )

virtual

Write the forces.

Reimplemented from forces.

Definition at line 183 of file forceCoeffs.C.

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

Here is the call graph for this function:

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ forceCoeffs()

◆ ~forceCoeffs()

Member Function Documentation

◆ writeFileHeader()

◆ TypeName()

◆ read()

◆ execute()

◆ write()