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

Inheritance diagram for tabulatedAccelerationSource:

Collaboration diagram for tabulatedAccelerationSource:

[legend]

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

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

virtual	~tabulatedAccelerationSource ()
	Destructor. More...

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

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

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

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

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

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

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

virtual	~option ()
	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...

bool	active () const
	Return const access to the source active flag. More...

void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi. More...

Switch &	active ()
	Return access to the source active flag. More...

virtual bool	isActive ()
	Is the source active? More...

virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list. More...

virtual void	checkApplied () const
	Check that the source has been applied. More...

virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< vector > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	correct (volScalarField &field)

virtual void	correct (volVectorField &field)

virtual void	correct (volSphericalTensorField &field)

virtual void	correct (volSymmTensorField &field)

virtual void	correct (volTensorField &field)

virtual void	writeHeader (Ostream &) const
	Write the source header information. More...

virtual void	writeFooter (Ostream &) const
	Write the source footer information. More...

virtual void	writeData (Ostream &) const
	Write the source properties. More...

Protected Attributes
tabulated6DoFAcceleration	motion_
	Run-time selectable acceleration model. More...

word	UName_
	Velocity field name, default = U. More...

dimensionedVector	g0_

Protected Attributes inherited from option
const word	name_
	Source name. More...

const word	modelType_
	Model type. More...

const fvMesh &	mesh_
	Reference to the mesh database. More...

dictionary	dict_
	Top level source dictionary. More...

dictionary	coeffs_
	Dictionary containing source coefficients. More...

Switch	active_
	Source active flag. More...

wordList	fieldNames_
	Field names to apply source to - populated by derived models. More...

List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry. More...

Additional Inherited Members
Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvOption model. More...

Detailed Description

Solid-body 6-DoF acceleration source.

Usage

Example usage:

SBM
{
    type            tabulatedAccelerationSource;
    active          yes;

    tabulatedAccelerationSourceCoeffs
    {
        timeDataFileName "constant/acceleration-terms.dat";
    }
}

Source files

Definition at line 68 of file tabulatedAccelerationSource.H.

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 52 of file tabulatedAccelerationSource.C.

References objectRegistry::foundObject(), and objectRegistry::lookupObject().

Here is the call graph for this function:

virtual ~tabulatedAccelerationSource ( )

inlinevirtual

Destructor.

Definition at line 125 of file tabulatedAccelerationSource.H.

References dict, tabulatedAccelerationSource::read(), and rho.

Here is the call graph for this function:

Member Function Documentation

TypeName ( "tabulatedAccelerationSource" )

Runtime type information.

void addSup	(	fvMatrix< vector > &	eqn,
		const label	fieldi
	)

virtual

Source term to momentum equation.

Reimplemented from option.

Definition at line 77 of file tabulatedAccelerationSource.C.

void addSup	(	const volScalarField &	rho,
		fvMatrix< vector > &	eqn,
		const label	fieldi
	)

virtual

Source term to compressible momentum equation.

Reimplemented from option.

Definition at line 87 of file tabulatedAccelerationSource.C.

References rho.

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from option.

Definition at line 97 of file tabulatedAccelerationSource.C.

References option::read().

Referenced by tabulatedAccelerationSource::~tabulatedAccelerationSource().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

tabulated6DoFAcceleration motion_

protected

Run-time selectable acceleration model.

Definition at line 78 of file tabulatedAccelerationSource.H.

word UName_

protected

Velocity field name, default = U.

Definition at line 81 of file tabulatedAccelerationSource.H.

dimensionedVector g0_

protected

Definition at line 83 of file tabulatedAccelerationSource.H.

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

src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.H
src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSource.C
src/fvOptions/sources/derived/tabulatedAccelerationSource/tabulatedAccelerationSourceTemplates.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation