tabulatedAccelerationSource Class Reference

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

Inheritance diagram for tabulatedAccelerationSource:

Collaboration diagram for tabulatedAccelerationSource:

Public Member Functions
	TypeName ("tabulatedAccelerationSource")
	tabulatedAccelerationSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	tabulatedAccelerationSource (const tabulatedAccelerationSource &)=delete
void	operator= (const tabulatedAccelerationSource &)=delete
virtual	~tabulatedAccelerationSource ()=default
virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)
virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
virtual bool	read (const dictionary &dict)
Public Member Functions inherited from option
	TypeName ("option")
	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)
autoPtr< option >	clone () const
virtual	~option ()=default
const word &	name () const noexcept
const fvMesh &	mesh () const noexcept
const dictionary &	coeffs () const noexcept
bool	active () const noexcept
void	setApplied (const label fieldi)
bool	active (const bool on) noexcept
virtual bool	isActive ()
virtual label	applyToField (const word &fieldName) const
virtual void	checkApplied () const
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	postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	writeHeader (Ostream &) const
virtual void	writeFooter (Ostream &) const
virtual void	writeData (Ostream &) const

Protected Attributes
tabulated6DoFAcceleration	motion_
word	UName_
dimensionedVector	g0_
Protected Attributes inherited from option
const word	name_
const word	modelType_
const fvMesh &	mesh_
dictionary	dict_
dictionary	coeffs_
wordList	fieldNames_
List< bool >	applied_
bool	active_

Additional Inherited Members
Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
Public Attributes inherited from option
bool	log
Protected Member Functions inherited from option
void	resetApplied ()

Detailed Description

Solid-body 6-DoF acceleration source.

Usage

Minimal example by using constant/fvOptions:

tabulatedAccelerationSource1
{
    // Mandatory entries (unmodifiable)
    type             tabulatedAccelerationSource;
    timeDataFileName "constant/acceleration-terms.dat";

    // Optional entries (unmodifiable)
    U                U;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
type	Type name: tabulatedAccelerationSource	word	yes	-
timeDataFileName	Name of tabulated data file	word	yes	-
U	Name of operand velocity field	word	no	U

The inherited entries are elaborated in:

• fvOption.H

Source files

• tabulatedAccelerationSource.H
• tabulatedAccelerationSource.C
• tabulatedAccelerationSourceTemplates.C

Definition at line 107 of file tabulatedAccelerationSource.H.

Constructor & Destructor Documentation

tabulatedAccelerationSource() [1/2]

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

Definition at line 43 of file tabulatedAccelerationSource.C.

References mesh.

tabulatedAccelerationSource() [2/2]

tabulatedAccelerationSource ( const tabulatedAccelerationSource &  )

delete

~tabulatedAccelerationSource()

virtual ~tabulatedAccelerationSource ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"tabulatedAccelerationSource"

)

operator=()

void operator= ( const tabulatedAccelerationSource &  )

delete

addSup() [1/2]

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

virtual

Reimplemented from option.

Definition at line 68 of file tabulatedAccelerationSource.C.

addSup() [2/2]

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

virtual

Reimplemented from option.

Definition at line 78 of file tabulatedAccelerationSource.C.

References rho.

read()

bool read ( const dictionary &  dict )

virtual

Reimplemented from option.

Definition at line 88 of file tabulatedAccelerationSource.C.

References option::coeffs_, dict, tabulatedAccelerationSource::motion_, tabulated6DoFAcceleration::read(), and option::read().

Here is the call graph for this function:

Member Data Documentation

motion_

tabulated6DoFAcceleration motion_

protected

Definition at line 116 of file tabulatedAccelerationSource.H.

Referenced by tabulatedAccelerationSource::read().

UName_

word UName_

protected

Definition at line 119 of file tabulatedAccelerationSource.H.

g0_

dimensionedVector g0_

protected

Definition at line 122 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