Base class for sectional forces function objects. More...

Inheritance diagram for sectionalForcesBase:

[legend]

Collaboration diagram for sectionalForcesBase:

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

	sectionalForcesBase (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	sectionalForcesBase (const sectionalForcesBase &)=delete
	Disallow default bitwise copy construction. More...

virtual	~sectionalForcesBase ()
	Destructor. More...

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

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	execute ()
	Execute, currently does nothing. More...

virtual bool	end ()
	Execute at the final time-loop, currently does nothing. More...

virtual void	movePoints (const polyMesh &)
	Update for mesh point-motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

void	operator= (const sectionalForcesBase &)=delete
	Disallow default bitwise assignment. More...

template<class Type >
Foam::tmp< Foam::SurfaceField< Type > >	timesAlpha (const tmp< SurfaceField< Type >> psi) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	timesAlpha (const tmp< Field< Type >> psi, const label patchi) const

template<class Type >
Foam::tmp< Foam::SurfaceField< Type > >	timesRho (const tmp< SurfaceField< Type >> psi) const

template<class Type >
Foam::tmp< Foam::SurfaceField< Type > >	timesAlphaRho (const tmp< SurfaceField< Type >> psi) const

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)
	Construct from the region objectRegistry. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

const fvMesh &	mesh () const
	Return a reference to the mesh. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. 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)
	Construct from the region objectRegistry. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from objectRegistryFunctionObject
	TypeName ("objectRegistryFunctionObject")
	Runtime type information. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

	objectRegistryFunctionObject (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

void	operator= (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("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, const Time &runTime)
	Construct from components. More...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. More...

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

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

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

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	write ()=0
	Called at each ++ or += of the time-loop. More...

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Protected Member Functions
virtual void	clear ()
	Clear the cached weights. More...

const indirectPrimitivePatch &	patch () const
	Access the primitive patch. More...

void	clearPatch ()
	Clear the patch. More...

void	clearPatchGeom ()
	Clear the patch geometry. More...

virtual vector	normal () const =0
	Return the normal to the section planes. More...

virtual point	origin () const =0
	Return the origin of the plot. This can be an arbitrary point. More...

virtual tmp< scalarField >	distances () const =0
	Return the distances from the origin to the section planes. This is. More...

tmp< scalarField >	patchPointDistances () const
	Return the distance from the origin to the patch points. More...

const List< patchCutPlot::weight > &	weights () const
	Access the weights. More...

fileName	outputPath () const
	Return the output path. More...

void	addFluid (vectorField &force, vectorField &moment) const
	Calculate the forces and moments at the cuts. More...

Protected Member Functions inherited from objectRegistryFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames cannot be found. 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 >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	store (const 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...

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

Switch	executeAtStart_
	Switch execute at start time. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

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

Protected Attributes inherited from objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

Base class for sectional forces function objects.

Source files

Definition at line 54 of file sectionalForcesBase.H.

Constructor & Destructor Documentation

◆ sectionalForcesBase() [1/2]

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

Construct from Time and dictionary.

Definition at line 454 of file sectionalForcesBase.C.

References dict, and sectionalForcesBase::read().

Here is the call graph for this function:

◆ sectionalForcesBase() [2/2]

sectionalForcesBase ( const sectionalForcesBase & )

delete

Disallow default bitwise copy construction.

◆ ~sectionalForcesBase()

~sectionalForcesBase ( )

virtual

Destructor.

Definition at line 478 of file sectionalForcesBase.C.

Member Function Documentation

◆ clear()

void clear ( )

protectedvirtual

Clear the cached weights.

Definition at line 239 of file sectionalForcesBase.C.

◆ patch()

const Foam::indirectPrimitivePatch & patch ( ) const

protected

Access the primitive patch.

Definition at line 246 of file sectionalForcesBase.C.

References List< T >::append(), polyMesh::boundary(), forAllConstIter, Foam::identityMap(), mesh, points, fvMesh::poly(), UList< T >::size(), and polyPatch::start().

Here is the call graph for this function:

◆ clearPatch()

void clearPatch ( )

protected

Clear the patch.

Definition at line 273 of file sectionalForcesBase.C.

◆ clearPatchGeom()

void clearPatchGeom ( )

protected

Clear the patch geometry.

Definition at line 282 of file sectionalForcesBase.C.

◆ normal()

virtual vector normal ( ) const

protectedpure virtual

Return the normal to the section planes.

Implemented in rigidBodySectionalForcesBase, sectionalForceProbes, and sectionalForceGraph.

◆ origin()

virtual point origin ( ) const

protectedpure virtual

Return the origin of the plot. This can be an arbitrary point.

somewhere along the 1-D 'beam' that the geometry is reduced to.

Implemented in rigidBodySectionalForcesBase, sectionalForceProbes, and sectionalForceGraph.

◆ distances()

virtual tmp<scalarField> distances ( ) const

protectedpure virtual

Return the distances from the origin to the section planes. This is.

the coordinate that we plot against.

Implemented in sectionalForceProbes, and sectionalForceGraph.

◆ patchPointDistances()

Foam::tmp< Foam::scalarField > patchPointDistances ( ) const

protected

Return the distance from the origin to the patch points.

in the normal direction

Definition at line 292 of file sectionalForcesBase.C.

◆ weights()

const Foam::List< Foam::patchCutPlot::weight > & weights ( ) const

protected

Access the weights.

Definition at line 299 of file sectionalForcesBase.C.

References Foam::patchCutPlot::calcWeights().

Here is the call graph for this function:

◆ outputPath()

Foam::fileName outputPath ( ) const

protected

Return the output path.

Definition at line 323 of file sectionalForcesBase.C.

References polyMesh::defaultRegion, Foam::name(), and writeFile::outputPrefix.

Here is the call graph for this function:

◆ addFluid()

void addFluid	(	vectorField &	force,
		vectorField &	moment
	)		const

protected

Calculate the forces and moments at the cuts.

Definition at line 334 of file sectionalForcesBase.C.

References Foam::cutPlot::applyWeights(), polyMesh::boundary(), GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), forcesBase::calcForcesMoments(), Foam::endl(), dictionary::entries(), f(), polyPatch::faceCentres(), PrimitivePatch< FaceList, PointField >::faceNormals(), UList< T >::first(), forAllConstIter, forAllReverse, Foam::dimensions::force, forcesBase::forceEff(), Foam::gMax(), Foam::gMin(), Foam::Info, UList< T >::last(), mesh, forcesBase::momentEff(), patchIdentifier::name(), Foam::nl, p, patchNames(), fvMesh::poly(), UList< T >::size(), List< T >::size(), Foam::dimensions::time, Foam::type(), Foam::typeName(), and VectorSpace< Form, Cmpt, Ncmpts >::zero.

Referenced by rigidBodySectionalForcesBase::addFluid(), sectionalForceGraph::write(), and sectionalForceProbes::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "sectionalForcesBase" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the sectionalForcesBase data.

Reimplemented from objectRegistryFunctionObject.

Reimplemented in rigidBodySectionalForcesBase, rigidBodySectionalForceProbes, rigidBodySectionalForceGraph, sectionalForceProbes, and sectionalForceGraph.

Definition at line 484 of file sectionalForcesBase.C.

References polyMesh::boundary(), dict, IOobject::groupName(), mesh, word::null, polyBoundaryMesh::patchSet(), fvMesh::poly(), and objectRegistryFunctionObject::read().

Referenced by sectionalForceGraph::read(), sectionalForceProbes::read(), rigidBodySectionalForcesBase::read(), and sectionalForcesBase::sectionalForcesBase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 526 of file sectionalForcesBase.C.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 532 of file sectionalForcesBase.C.

◆ end()

bool end ( )

virtual

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

Reimplemented from functionObject.

Definition at line 538 of file sectionalForcesBase.C.

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for mesh point-motion.

Reimplemented from functionObject.

Reimplemented in rigidBodySectionalForcesBase.

Definition at line 544 of file sectionalForcesBase.C.

References clear(), and mesh.

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 557 of file sectionalForcesBase.C.

References clear(), and polyTopoChangeMap::mesh().

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 570 of file sectionalForcesBase.C.

References clear(), and polyMeshMap::mesh().

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Reimplemented from functionObject.

Definition at line 583 of file sectionalForcesBase.C.

References clear(), and polyDistributionMap::mesh().

Here is the call graph for this function:

◆ operator=()

void operator= ( const sectionalForcesBase & )

delete

Disallow default bitwise assignment.

◆ timesAlpha() [1/2]

Foam::tmp<Foam::SurfaceField<Type> > timesAlpha ( const tmp< SurfaceField< Type >> psi ) const

Definition at line 61 of file sectionalForcesBase.C.

References alpha(), IOobject::groupName(), Foam::fvc::interpolate(), objectRegistry::lookupObject(), fvMeshFunctionObject::mesh(), word::null, and psi.

Here is the call graph for this function:

◆ timesAlpha() [2/2]

Foam::tmp<Foam::Field<Type> > timesAlpha	(	const tmp< Field< Type >>	psi,
		const label	patchi
	)		const

Definition at line 83 of file sectionalForcesBase.C.

References alpha(), IOobject::groupName(), objectRegistry::lookupObject(), mesh, word::null, patchi, and psi.

Here is the call graph for this function:

◆ timesRho()

Foam::tmp<Foam::SurfaceField<Type> > timesRho ( const tmp< SurfaceField< Type >> psi ) const

Definition at line 106 of file sectionalForcesBase.C.

References Foam::dimDensity, Foam::fvc::interpolate(), objectRegistry::lookupObject(), mesh, psi, and rho.

Here is the call graph for this function:

◆ timesAlphaRho()

Foam::tmp<Foam::SurfaceField<Type> > timesAlphaRho ( const tmp< SurfaceField< Type >> psi ) const

Definition at line 129 of file sectionalForcesBase.C.

References alpha(), IOobject::groupName(), Foam::fvc::interpolate(), objectRegistry::lookupObject(), mesh, word::null, psi, and rho.

Here is the call graph for this function:

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sectionalForcesBase() [1/2]

◆ sectionalForcesBase() [2/2]

◆ ~sectionalForcesBase()

Member Function Documentation

◆ clear()

◆ patch()

◆ clearPatch()

◆ clearPatchGeom()

◆ normal()

◆ origin()

◆ distances()

◆ patchPointDistances()

◆ weights()

◆ outputPath()

◆ addFluid()

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ end()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ operator=()

◆ timesAlpha() [1/2]

◆ timesAlpha() [2/2]

◆ timesRho()

◆ timesAlphaRho()