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

Inheritance diagram for tabulatedAccelerationSource:

Collaboration diagram for tabulatedAccelerationSource:

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...

	tabulatedAccelerationSource (const tabulatedAccelerationSource &)=delete
	No copy construct. More...

void	operator= (const tabulatedAccelerationSource &)=delete
	No copy assignment. More...

virtual	~tabulatedAccelerationSource ()=default
	Destructor. More...

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

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

virtual bool	read (const dictionary &dict)
	Read source 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 ()=default
	Destructor. More...

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

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

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

bool	active () const noexcept
	True if source is active. More...

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

bool	active (const bool on) noexcept
	Change source active flag, return previous value. 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< vector > &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< vector > &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
	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...

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

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

word	UName_
	Name of operand velocity field. More...

dimensionedVector	g0_
	Gravitational accelaration. More...

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...

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...

bool	active_
	Source active flag. 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...

Public Attributes inherited from option
bool	log
	Switch write log to Info. More...

Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries. More...

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

Definition at line 111 of file tabulatedAccelerationSource.H.

Constructor & Destructor Documentation

◆ tabulatedAccelerationSource() [1/2]

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

Construct from components.

Definition at line 49 of file tabulatedAccelerationSource.C.

References Foam::dimAcceleration, option::fieldNames_, objectRegistry::foundObject(), tabulatedAccelerationSource::g0_, objectRegistry::lookupObject(), option::mesh(), Foam::name(), option::resetApplied(), List< T >::resize(), fvMesh::time(), and tabulatedAccelerationSource::UName_.

Here is the call graph for this function:

◆ tabulatedAccelerationSource() [2/2]

tabulatedAccelerationSource ( const tabulatedAccelerationSource & )

delete

No copy construct.

◆ ~tabulatedAccelerationSource()

virtual ~tabulatedAccelerationSource ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "tabulatedAccelerationSource" )

Runtime type information.

◆ operator=()

void operator= ( const tabulatedAccelerationSource & )

delete

No copy assignment.

◆ addSup() [1/2]

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

virtual

Add explicit contribution to momentum equation.

Reimplemented from option.

Definition at line 74 of file tabulatedAccelerationSource.C.

◆ addSup() [2/2]

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

virtual

Add explicit contribution to compressible momentum equation.

Reimplemented from option.

Definition at line 84 of file tabulatedAccelerationSource.C.

References rho.

◆ read()

bool read ( const dictionary & dict )

virtual

Read source dictionary.

Reimplemented from option.

Definition at line 95 of file tabulatedAccelerationSource.C.

References dict, and kEpsilonLopesdaCosta< BasicTurbulenceModel >::read().

Here is the call graph for this function:

Member Data Documentation

◆ motion_

tabulated6DoFAcceleration motion_

protected

Run-time selectable acceleration model.

Definition at line 120 of file tabulatedAccelerationSource.H.

◆ UName_

word UName_

protected

Name of operand velocity field.

Definition at line 123 of file tabulatedAccelerationSource.H.

Referenced by tabulatedAccelerationSource::tabulatedAccelerationSource().

◆ g0_

dimensionedVector g0_

protected

Gravitational accelaration.

Definition at line 126 of file tabulatedAccelerationSource.H.

Referenced by tabulatedAccelerationSource::tabulatedAccelerationSource().

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

◆ tabulatedAccelerationSource() [1/2]

◆ tabulatedAccelerationSource() [2/2]

◆ ~tabulatedAccelerationSource()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ read()

Member Data Documentation

◆ motion_

◆ UName_

◆ g0_