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

Inheritance diagram for sixDoFAccelerationSource:

Collaboration diagram for sixDoFAccelerationSource:

Public Types
typedef Vector< vector >	accelerationVectors
	Accelerations type comprising. More...

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

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

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

virtual	~sixDoFAccelerationSource ()
	Destructor. More...

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

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

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

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

void	operator= (const sixDoFAccelerationSource &)=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 dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))

	fvModel (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	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 fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs () const
	Return dictionary. More...

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

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_SUP)
	Add a source term to an equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_SUP)
	Add a source term to a compressible equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_SUP)
	Add a source term to a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for an equation with a specified name. More...

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

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for a compressible equation with a specified name. More...

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

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for a phase equation with a specified name. More...

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

virtual void	updateMesh (const mapPolyMesh &)
	Update for mesh changes. More...

virtual bool	movePoints ()
	Update for mesh motion. More...

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

template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)

template<class Type >
Foam::dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

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

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

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

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)
	Return the dimensions of the matrix of a source term. More...

template<class Type >
static dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

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

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

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

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

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
	Return source for equation with specified name and dimensions. More...

Detailed Description

Solid-body 6-DoF acceleration source.

Usage

Example usage:

SBM
{
    type            sixDoFAccelerationSource;

    accelerations   <function1>;
}

Source files

Definition at line 63 of file sixDoFAccelerationSource.H.

Member Typedef Documentation

◆ accelerationVectors

typedef Vector<vector> accelerationVectors

Accelerations type comprising.

linear acceleration vector angular velocity vector angular acceleration vector

Definition at line 73 of file sixDoFAccelerationSource.H.

Constructor & Destructor Documentation

◆ sixDoFAccelerationSource() [1/2]

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

Construct from components.

Definition at line 129 of file sixDoFAccelerationSource.C.

◆ sixDoFAccelerationSource() [2/2]

sixDoFAccelerationSource ( const sixDoFAccelerationSource & )

delete

Disallow default bitwise copy construction.

◆ ~sixDoFAccelerationSource()

virtual ~sixDoFAccelerationSource ( )

inlinevirtual

Destructor.

Definition at line 133 of file sixDoFAccelerationSource.H.

References sixDoFAccelerationSource::addSupFields(), sixDoFAccelerationSource::operator=(), and sixDoFAccelerationSource::read().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "sixDoFAccelerationSource" )

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 152 of file sixDoFAccelerationSource.C.

Referenced by sixDoFAccelerationSource::~sixDoFAccelerationSource().

Here is the caller graph for this function:

◆ addSup() [1/2]

void addSup	(	fvMatrix< vector > &	eqn,
		const word &	fieldName
	)		const

virtual

Source term to momentum equation.

Definition at line 159 of file sixDoFAccelerationSource.C.

◆ addSup() [2/2]

void addSup	(	const volScalarField &	rho,
		fvMatrix< vector > &	eqn,
		const word &	fieldName
	)		const

virtual

Source term to compressible momentum equation.

Definition at line 169 of file sixDoFAccelerationSource.C.

References rho.

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from fvModel.

Definition at line 179 of file sixDoFAccelerationSource.C.

References fvModel::read().

Referenced by sixDoFAccelerationSource::~sixDoFAccelerationSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const sixDoFAccelerationSource & )

delete

Disallow default bitwise assignment.

Referenced by sixDoFAccelerationSource::~sixDoFAccelerationSource().

Here is the caller graph for this function:

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

src/fvModels/derived/sixDoFAccelerationSource/sixDoFAccelerationSource.H
src/fvModels/derived/sixDoFAccelerationSource/sixDoFAccelerationSource.C
src/fvModels/derived/sixDoFAccelerationSource/sixDoFAccelerationSourceTemplates.C

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ accelerationVectors

Constructor & Destructor Documentation

◆ sixDoFAccelerationSource() [1/2]

◆ sixDoFAccelerationSource() [2/2]

◆ ~sixDoFAccelerationSource()

Member Function Documentation

◆ TypeName()

◆ addSupFields()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ read()

◆ operator=()