Base class for rigid-body sectional forces function objects. More...

Inheritance diagram for rigidBodySectionalForcesBase:

[legend]

Collaboration diagram for rigidBodySectionalForcesBase:

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

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

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

virtual	~rigidBodySectionalForcesBase ()
	Destructor. More...

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

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

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

Public Member Functions inherited from sectionalForcesBase
	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 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	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
const RBD::rigidBodyMotion &	motion () const
	Return the motion system. More...

label	bodyIndex () const
	Return the index of the body. More...

const RBD::rigidBody &	body () const
	Return the body. More...

label	axisi () const
	Return the axis on which to plot the result. More...

const word &	axisName () const
	Return the name of the axis on which to plot the result. More...

vector	axis () const
	Return the vector axis on which to plot the result. Note that this. More...

const point &	localOrigin () const
	Return the local origin of the plot. More...

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

virtual point	origin () const
	Return the origin of the plot. More...

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

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

Protected Member Functions inherited from sectionalForcesBase
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 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 rigid-body sectional forces function objects.

Source files

Definition at line 52 of file rigidBodySectionalForcesBase.H.

Constructor & Destructor Documentation

◆ rigidBodySectionalForcesBase() [1/2]

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

Construct from Time and dictionary.

Definition at line 225 of file rigidBodySectionalForcesBase.C.

References dict, and rigidBodySectionalForcesBase::read().

Here is the call graph for this function:

◆ rigidBodySectionalForcesBase() [2/2]

rigidBodySectionalForcesBase ( const rigidBodySectionalForcesBase & )

delete

Disallow default bitwise copy construction.

◆ ~rigidBodySectionalForcesBase()

~rigidBodySectionalForcesBase ( )

virtual

Destructor.

Definition at line 242 of file rigidBodySectionalForcesBase.C.

Member Function Documentation

◆ motion()

const Foam::RBD::rigidBodyMotion & motion ( ) const

protected

Return the motion system.

Definition at line 82 of file rigidBodySectionalForcesBase.C.

References fvMeshFunctionObject::mesh_, fvMesh::mover(), and pointMeshMover::mover().

Here is the call graph for this function:

◆ bodyIndex()

Foam::label bodyIndex ( ) const

protected

Return the index of the body.

Definition at line 92 of file rigidBodySectionalForcesBase.C.

◆ body()

const Foam::RBD::rigidBody & body ( ) const

protected

Return the body.

Definition at line 99 of file rigidBodySectionalForcesBase.C.

◆ axisi()

Foam::label axisi ( ) const

protected

Return the axis on which to plot the result.

Definition at line 105 of file rigidBodySectionalForcesBase.C.

◆ axisName()

const Foam::word & axisName ( ) const

protected

Return the name of the axis on which to plot the result.

Definition at line 112 of file rigidBodySectionalForcesBase.C.

References coordSet::axisTypeNames_.

◆ axis()

Foam::vector axis ( ) const

protected

Return the vector axis on which to plot the result. Note that this.

is in the local coordinate system of the body. The global axis is given by the 'normal' method.

Definition at line 118 of file rigidBodySectionalForcesBase.C.

References VectorSpace< Form, Cmpt, Ncmpts >::zero.

◆ localOrigin()

const Foam::point & localOrigin ( ) const

protected

Return the local origin of the plot.

Definition at line 127 of file rigidBodySectionalForcesBase.C.

◆ normal()

Foam::vector normal ( ) const

protectedvirtual

Return the normal to the section planes.

Implements sectionalForcesBase.

Definition at line 133 of file rigidBodySectionalForcesBase.C.

◆ origin()

Foam::point origin ( ) const

protectedvirtual

Return the origin of the plot.

Implements sectionalForcesBase.

Definition at line 139 of file rigidBodySectionalForcesBase.C.

◆ addFluid()

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

protected

Calculate the forces and moments at the cuts.

Definition at line 145 of file rigidBodySectionalForcesBase.C.

References sectionalForcesBase::addFluid(), Foam::dimensions::force, List< T >::size(), Foam::transform(), and VectorSpace< Form, Cmpt, Ncmpts >::zero.

Referenced by rigidBodySectionalForceGraph::write(), and rigidBodySectionalForceProbes::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addBody()

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

protected

Calculate the forces and moments at the cuts.

Definition at line 168 of file rigidBodySectionalForcesBase.C.

References Foam::AxCrossX(), f(), forAllReverse, Foam::dimensions::force, w0, and VectorSpace< Form, Cmpt, Ncmpts >::zero.

Referenced by rigidBodySectionalForceGraph::write(), and rigidBodySectionalForceProbes::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "rigidBodySectionalForcesBase" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the rigidBodySectionalForcesBase data.

Reimplemented from sectionalForcesBase.

Reimplemented in rigidBodySectionalForceProbes, and rigidBodySectionalForceGraph.

Definition at line 249 of file rigidBodySectionalForcesBase.C.

References coordSet::axisTypeNames_, dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::name(), Foam::read(), sectionalForcesBase::read(), NamedEnum< Enum, nEnum >::read(), coordSet::X, coordSet::Y, and coordSet::Z.

Referenced by rigidBodySectionalForceGraph::read(), rigidBodySectionalForceProbes::read(), and rigidBodySectionalForcesBase::rigidBodySectionalForcesBase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for mesh point-motion.

Reimplemented from sectionalForcesBase.

Definition at line 286 of file rigidBodySectionalForcesBase.C.

References mesh.

◆ operator=()

void operator= ( const rigidBodySectionalForcesBase & )

delete

Disallow default bitwise assignment.

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

src/rigidBodyMotion/rigidBodyForces/rigidBodySectionalForcesBase/rigidBodySectionalForcesBase.H
src/rigidBodyMotion/rigidBodyForces/rigidBodySectionalForcesBase/rigidBodySectionalForcesBase.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ rigidBodySectionalForcesBase() [1/2]

◆ rigidBodySectionalForcesBase() [2/2]

◆ ~rigidBodySectionalForcesBase()

Member Function Documentation

◆ motion()

◆ bodyIndex()

◆ body()

◆ axisi()

◆ axisName()

◆ axis()

◆ localOrigin()

◆ normal()

◆ origin()

◆ addFluid()

◆ addBody()

◆ TypeName()

◆ read()

◆ movePoints()

◆ operator=()