Acoustic damping source. More...

Inheritance diagram for acousticDampingSource:

Collaboration diagram for acousticDampingSource:

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

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

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

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

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

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldI)
	Add implicit contribution to phase momentum equation. More...

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

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

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

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

scalar	timeStart () const
	Return const access to the time start. More...

scalar	duration () const
	Return const access to the duration. More...

bool	inTimeLimits (const scalar time) const
	Return true if within time limits. More...

const selectionModeType &	selectionMode () const
	Return const access to the cell selection mode. More...

const word &	cellSetName () const
	Return const access to the name of cell set for "cellSet". More...

scalar	V () const
	Return const access to the total cell volume. More...

const labelList &	cells () const
	Return const access to the cell set. More...

scalar &	timeStart ()
	Return access to the time start. More...

scalar &	duration ()
	Return access to the duration. More...

virtual bool	isActive ()
	Is the source active? 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
	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 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< 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 Member Functions
void	setBlendingFactor ()
	Helper function to set the blending factor. More...

Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)
	Set the cellSet or points selection. More...

void	setCellSet ()
	Set the cell set based on the user input selection mode. More...

void	setVol ()
	Recalculate the volume. More...

Protected Attributes
dimensionedScalar	frequency_
	Frequency [Hz]. More...

volScalarField	blendFactor_
	Blending factor []. More...

word	URefName_
	Name of reference velocity field. More...

point	x0_

scalar	r1_

scalar	r2_

label	w_
	Stencil width, default = 20. More...

Protected Attributes inherited from cellSetOption
scalar	timeStart_
	Time start. More...

scalar	duration_
	Duration. More...

selectionModeType	selectionMode_
	Cell selection mode. More...

word	cellSetName_
	Name of set/zone for "cellSet" and "cellZone" selectionMode. More...

List< point >	points_
	List of points for "points" selectionMode. More...

labelList	cells_
	Set of cells to apply source to. More...

scalar	V_
	Sum of cell volumes. 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...

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
Public Types inherited from cellSetOption
enum	selectionModeType { smPoints, smCellSet, smCellZone, smAll }
	Enumeration for selection mode types. More...

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

Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_
	List of selection mode type names. More...

Detailed Description

Acoustic damping source.

Source usage

Example usage:

acousticDampingSourceCoeffs
{
    timeStart        0.004;
    duration         1000.0;
    selectionMode    all;
    origin           (-1.25 0 0);
    radius1          1.2;
    radius2          1.65;
    frequency        3000;
    URef             UMean;
}

Source files

Definition at line 77 of file acousticDampingSource.H.

Constructor & Destructor Documentation

◆ acousticDampingSource()

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

Construct from components.

Definition at line 85 of file acousticDampingSource.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~acousticDampingSource()

virtual ~acousticDampingSource ( )

virtualdefault

Destructor.

Member Function Documentation

◆ setBlendingFactor()

void setBlendingFactor ( )

protected

Helper function to set the blending factor.

Definition at line 55 of file acousticDampingSource.C.

References acousticDampingSource::blendFactor_, fvMesh::C(), cellSetOption::cells_, GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::cos(), forAll, Foam::mag(), option::mesh_, Foam::constant::mathematical::pi(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), acousticDampingSource::r1_, acousticDampingSource::r2_, and acousticDampingSource::x0_.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "acousticDampingSource" )

Runtime type information.

◆ addSup() [1/3]

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

virtual

Add implicit contribution to momentum equation.

Reimplemented from option.

Definition at line 124 of file acousticDampingSource.C.

References mesh, fvMatrix< Type >::psi(), Foam::fvm::Sp(), and U.

Here is the call graph for this function:

◆ addSup() [2/3]

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

virtual

Add implicit contribution to compressible momentum equation.

Reimplemented from option.

Definition at line 142 of file acousticDampingSource.C.

References mesh, fvMatrix< Type >::psi(), rho, Foam::fvm::Sp(), and U.

Here is the call graph for this function:

◆ addSup() [3/3]

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

virtual

Add implicit contribution to phase momentum equation.

Reimplemented from option.

Definition at line 161 of file acousticDampingSource.C.

References Foam::constant::atomic::alpha, mesh, fvMatrix< Type >::psi(), rho, Foam::fvm::Sp(), and U.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from cellSetOption.

Definition at line 180 of file acousticDampingSource.C.

References dict, Foam::endl(), Foam::Info, and cellSetOption::read().

Here is the call graph for this function:

Member Data Documentation

◆ frequency_

dimensionedScalar frequency_

protected

Frequency [Hz].

Definition at line 87 of file acousticDampingSource.H.

◆ blendFactor_

volScalarField blendFactor_

protected

Blending factor [].

Definition at line 90 of file acousticDampingSource.H.

Referenced by acousticDampingSource::setBlendingFactor().

◆ URefName_

word URefName_

protected

Name of reference velocity field.

Definition at line 93 of file acousticDampingSource.H.

◆ x0_

point x0_

protected

Definition at line 96 of file acousticDampingSource.H.

Referenced by acousticDampingSource::setBlendingFactor().

◆ r1_

scalar r1_

protected

Definition at line 99 of file acousticDampingSource.H.

Referenced by acousticDampingSource::setBlendingFactor().

◆ r2_

scalar r2_

protected

Definition at line 102 of file acousticDampingSource.H.

Referenced by acousticDampingSource::setBlendingFactor().

◆ w_

label w_

protected

Stencil width, default = 20.

Definition at line 105 of file acousticDampingSource.H.

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

src/fvOptions/sources/derived/acousticDampingSource/acousticDampingSource.H
src/fvOptions/sources/derived/acousticDampingSource/acousticDampingSource.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ acousticDampingSource()

◆ ~acousticDampingSource()

Member Function Documentation

◆ setBlendingFactor()

◆ TypeName()

◆ addSup() [1/3]

◆ addSup() [2/3]

◆ addSup() [3/3]

◆ read()

Member Data Documentation

◆ frequency_

◆ blendFactor_

◆ URefName_

◆ x0_

◆ r1_

◆ r2_

◆ w_