OpenFOAM: forceCoeffs::coeffDesc Struct Reference

The open source CFD toolbox

Coefficients description. More...

Collaboration diagram for forceCoeffs::coeffDesc:

Collaboration graph

Public Types
enum	splitType { stFront, stRear, stNone }

Public Member Functions
	coeffDesc (const string &description, const word &name, const label c0, const label c1=-1)
	Construct from components. More...

const word	frontName () const noexcept
	Return name with front-name appendix. More...

const word	rearName () const noexcept
	Return name with rear-name appendix. More...

void	print (Ostream &os) const
	Print description. More...

vector	value (const forceComponents &f, const forceComponents &m) const
	Return force/moment components based on the specified split type. More...

coeffDesc	front () const
	Return front-axle coefficient description. More...

coeffDesc	rear () const
	Return rear-axle coefficient description. More...

Public Attributes
string	desc_

word	name_

label	c0_

label	c1_

bool	active_

splitType	splitType_

Detailed Description

Coefficients description.

Definition at line 526 of file forceCoeffs.H.

Member Enumeration Documentation

◆ splitType

Enumerator
stFront
stRear
stNone

Definition at line 528 of file forceCoeffs.H.

Constructor & Destructor Documentation

◆ coeffDesc()

coeffDesc	(	const string &	description,
		const word &	name,
		const label	c0,
		const label	c1 = `-1`
	)

inline

Construct from components.

Definition at line 548 of file forceCoeffs.H.

Member Function Documentation

◆ frontName()

const word frontName ( ) const

inlinenoexcept

Return name with front-name appendix.

Definition at line 566 of file forceCoeffs.H.

References forceCoeffs::coeffDesc::name_.

Referenced by forceCoeffs::coeffDesc::front().

Here is the caller graph for this function:

◆ rearName()

const word rearName ( ) const

inlinenoexcept

Return name with rear-name appendix.

Definition at line 574 of file forceCoeffs.H.

References forceCoeffs::coeffDesc::name_.

Referenced by forceCoeffs::coeffDesc::rear().

Here is the caller graph for this function:

◆ print()

void print ( Ostream & os ) const

inline

Print description.

Definition at line 582 of file forceCoeffs.H.

References forceCoeffs::coeffDesc::desc_, forceCoeffs::coeffDesc::name_, and os().

Here is the call graph for this function:

◆ value()

vector value	(	const forceComponents &	f,
		const forceComponents &	m
	)		const

inline

Return force/moment components based on the specified split type.

Definition at line 590 of file forceCoeffs.H.

References Foam::abort(), forceCoeffs::coeffDesc::c0_, forceCoeffs::coeffDesc::c1_, f(), Foam::FatalError, FatalErrorInFunction, forceCoeffs::coeffDesc::splitType_, forceCoeffs::coeffDesc::stFront, forceCoeffs::coeffDesc::stNone, and forceCoeffs::coeffDesc::stRear.

Here is the call graph for this function:

◆ front()

coeffDesc front ( ) const

inline

Return front-axle coefficient description.

Definition at line 625 of file forceCoeffs.H.

References forceCoeffs::coeffDesc::desc_, forceCoeffs::coeffDesc::frontName(), forceCoeffs::coeffDesc::name_, forceCoeffs::coeffDesc::splitType_, and forceCoeffs::coeffDesc::stFront.

Here is the call graph for this function:

◆ rear()

coeffDesc rear ( ) const

inline

Return rear-axle coefficient description.

Definition at line 637 of file forceCoeffs.H.

References forceCoeffs::coeffDesc::desc_, forceCoeffs::coeffDesc::name_, forceCoeffs::coeffDesc::rearName(), forceCoeffs::coeffDesc::splitType_, and forceCoeffs::coeffDesc::stRear.

Here is the call graph for this function:

Member Data Documentation

◆ desc_

string desc_

Definition at line 535 of file forceCoeffs.H.

Referenced by forceCoeffs::coeffDesc::front(), forceCoeffs::coeffDesc::print(), and forceCoeffs::coeffDesc::rear().

◆ name_

word name_

Definition at line 536 of file forceCoeffs.H.

Referenced by forceCoeffs::coeffDesc::front(), forceCoeffs::coeffDesc::frontName(), forceCoeffs::coeffDesc::print(), forceCoeffs::coeffDesc::rear(), and forceCoeffs::coeffDesc::rearName().

◆ c0_

label c0_

Definition at line 537 of file forceCoeffs.H.

Referenced by forceCoeffs::coeffDesc::value().

◆ c1_

label c1_

Definition at line 538 of file forceCoeffs.H.

Referenced by forceCoeffs::coeffDesc::value().

◆ active_

bool active_

Definition at line 539 of file forceCoeffs.H.

◆ splitType_

splitType splitType_

Definition at line 540 of file forceCoeffs.H.

Referenced by forceCoeffs::coeffDesc::front(), forceCoeffs::coeffDesc::rear(), and forceCoeffs::coeffDesc::value().

The documentation for this struct was generated from the following file:

src/functionObjects/forces/forceCoeffs/forceCoeffs.H