Solid-body 6-DoF acceleration source. More...

Inheritance diagram for sixDoFAcceleration:

Collaboration diagram for sixDoFAcceleration:

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

	sixDoFAcceleration (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

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

virtual	~sixDoFAcceleration ()
	Destructor. More...

virtual wordList	addSupFields () const
	Return the list of fields for which the fvModel adds source term. More...

virtual void	addSup (const volVectorField &U, fvMatrix< vector > &eqn) const
	Source term to momentum equation. More...

virtual void	addSup (const volScalarField &rho, const volVectorField &U, fvMatrix< vector > &eqn) const
	Source term to compressible momentum equation. More...

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, const volVectorField &U, fvMatrix< vector > &eqn) const
	Source term to phase momentum equation. More...

virtual bool	movePoints ()
	Update for mesh 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...

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

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

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

	declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict),(name, modelType, mesh, dict))

	fvModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

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

virtual	~fvModel ()
	Destructor. More...

const word &	name () const
	Return const access to the source name. More...

const word &	keyword () const
	Return name as the keyword. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs (const dictionary &) const
	Return the coefficients sub-dictionary. More...

virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...

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

virtual void	addSup (fvMatrix< scalar > &eqn) const
	Add a source term to a field-less proxy equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const
	Add a source term to an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const VolField< Type > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const
	Return source for an equation with a second time derivative. More...

virtual void	preUpdateMesh ()
	Prepare for mesh update. More...

virtual void	correct ()
	Correct the fvModel. More...

virtual bool	write (const bool write=true) const
	Write fvModel data. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType >
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const

Additional Inherited Members
Static Public Member Functions inherited from fvModel
static const dictionary &	coeffs (const word &modelType, const dictionary &)
	Return the coefficients sub-dictionary for a given model type. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the dimensions of the matrix of a source term. More...

static const dimensionSet &	sourceDims (const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the name of the field associated with a source term. More...

template<class AlphaRhoFieldType >
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField)
	Return the name of the field associated with a source term (base. More...

static const word &	fieldName ()
	Return the name of the field associated with a source term. Special. More...

static autoPtr< fvModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected fvModel. More...

Static Public Attributes inherited from fvModel
static const wordHashSet	keywords
	The keywords read by this class. More...

Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
	Return a source for an equation. More...

Detailed Description

Solid-body 6-DoF acceleration source.

Usage

Example usage:

SBM
{
    type            sixDoFAcceleration;

    accelerations   <function1>;
}

Source files

Definition at line 63 of file sixDoFAcceleration.H.

Constructor & Destructor Documentation

◆ sixDoFAcceleration() [1/2]

sixDoFAcceleration	(	const word &	name,
		const word &	modelType,
		const fvMesh &	mesh,
		const dictionary &	dict
	)

Construct from components.

Definition at line 158 of file sixDoFAcceleration.C.

References fvModel::coeffs(), and dict.

Here is the call graph for this function:

◆ sixDoFAcceleration() [2/2]

sixDoFAcceleration ( const sixDoFAcceleration & )

delete

Disallow default bitwise copy construction.

◆ ~sixDoFAcceleration()

virtual ~sixDoFAcceleration ( )

inlinevirtual

Destructor.

Definition at line 128 of file sixDoFAcceleration.H.

Member Function Documentation

◆ TypeName()

TypeName ( "sixDoFAcceleration" )

Runtime type information.

◆ addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the list of fields for which the fvModel adds source term.

to the transport equation

Reimplemented from fvModel.

Definition at line 184 of file sixDoFAcceleration.C.

◆ addSup() [1/3]

void addSup	(	const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Source term to momentum equation.

Definition at line 190 of file sixDoFAcceleration.C.

References U.

◆ addSup() [2/3]

void addSup	(	const volScalarField &	rho,
		const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Source term to compressible momentum equation.

Definition at line 200 of file sixDoFAcceleration.C.

References rho, and U.

◆ addSup() [3/3]

void addSup	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Source term to phase momentum equation.

Definition at line 211 of file sixDoFAcceleration.C.

References alpha(), rho, and U.

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 223 of file sixDoFAcceleration.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 229 of file sixDoFAcceleration.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 233 of file sixDoFAcceleration.C.

◆ distribute()

void distribute ( const polyDistributionMap & )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 237 of file sixDoFAcceleration.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from fvModel.

Definition at line 241 of file sixDoFAcceleration.C.

References dict, and fvModel::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const sixDoFAcceleration & )

delete

Disallow default bitwise assignment.

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

src/fvModels/general/sixDoFAcceleration/sixDoFAcceleration.H
src/fvModels/general/sixDoFAcceleration/sixDoFAcceleration.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sixDoFAcceleration() [1/2]

◆ sixDoFAcceleration() [2/2]

◆ ~sixDoFAcceleration()

Member Function Documentation

◆ TypeName()

◆ addSupFields()

◆ addSup() [1/3]

◆ addSup() [2/3]

◆ addSup() [3/3]

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ read()

◆ operator=()