Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
acousticDampingSource Class Reference
Numerics » Finite volume Options » Sources

Applies sources on velocity (i.e. U) within a specified region to enable acoustic damping. More...

Inheritance diagram for acousticDampingSource:
Inheritance graph
[legend]
Collaboration diagram for acousticDampingSource:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("acousticDampingSource")
 
 acousticDampingSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 
 acousticDampingSource (const acousticDampingSource &)=delete
 
void operator= (const acousticDampingSource &)=delete
 
virtual ~acousticDampingSource ()=default
 
virtual void addSup (fvMatrix< vector > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldI)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldI)
 
virtual bool read (const dictionary &dict)
 
- Public Member Functions inherited from cellSetOption
 TypeName ("cellSetOption")
 
 cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 
virtual ~cellSetOption ()=default
 
scalar timeStart () const noexcept
 
scalar duration () const noexcept
 
bool inTimeLimits (const scalar timeValue) const
 
selectionModeType selectionMode () const noexcept
 
bool useSubMesh () const noexcept
 
const word & cellSetName () const noexcept
 
scalar V () const noexcept
 
const labelList & cells () const noexcept
 
scalar timeStart (scalar val) noexcept
 
scalar duration (scalar val) noexcept
 
virtual bool isActive ()
 
- 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 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< 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 Member Functions

void setBlendingFactor ()
 
- Protected Member Functions inherited from cellSetOption
void setSelection (const dictionary &dict)
 
void setCellSelection ()
 
void setVol ()
 
- Protected Member Functions inherited from option
void resetApplied ()
 

Protected Attributes

volScalarField blendFactor_
 
dimensionedScalar frequency_
 
point x0_
 
scalar r1_
 
scalar r2_
 
word URefName_
 
label w_
 
- Protected Attributes inherited from cellSetOption
scalar timeStart_
 
scalar duration_
 
selectionModeType selectionMode_
 
word cellSetName_
 
List< point > points_
 
labelList cells_
 
scalar V_
 
- 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

- Public Types inherited from cellSetOption
enum  selectionModeType { smAll, smCellSet, smCellZone, smPoints }
 
- 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
 
- Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType > selectionModeTypeNames_
 

Detailed Description

Applies sources on velocity (i.e. U) within a specified region to enable acoustic damping.

Sources applied to: 

  U         | Velocity                                   [m/s]

Required fields: 

  U         | Velocity                                   [m/s]
Usage
Minimal example by using constant/fvOptions: 
acousticDampingSource1
{
    // Mandatory entries (unmodifiable)
    type                 acousticDampingSource;

    // Mandatory entries (runtime modifiable)
    frequency        3000;
    URef             UMean;
    origin           (-1.25 0 0);
    radius1          1.2;
    radius2          1.65;

    // Optional entries (runtime modifiable)
    w                20;

    // Conditional optional entries (runtime modifiable)
    // Either of the below

        // Option-1
        UNames           (<UName1> <UName2> ... <UNameN>);

        // Option-2
        U                U;

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

where the entries mean:

Property Description Type Reqd Dflt
type Type name: acousticDampingSource word yes -
frequency Frequency value [Hz] scalar yes -
URef Name of reference velocity field word yes -
origin Sphere centre location or damping vector yes -
radius1 Inner radius at which to start damping scalar yes -
radius2 Outer radius beyond which damping is applied scalar yes -
w Stencil width label no 20
UNames Names of operand velocity fields wordList cndtnl -
U Name of operand velocity field word cndtnl U

The inherited entries are elaborated in:

Source files

Definition at line 176 of file acousticDampingSource.H.

Constructor & Destructor Documentation

◆ acousticDampingSource() [1/2]

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

Definition at line 73 of file acousticDampingSource.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ acousticDampingSource() [2/2]

acousticDampingSource ( const acousticDampingSource &  )
delete

◆ ~acousticDampingSource()

virtual ~acousticDampingSource ( )
virtualdefault

Member Function Documentation

◆ setBlendingFactor()

void setBlendingFactor ( )
protected

Definition at line 43 of file acousticDampingSource.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "acousticDampingSource"  )

◆ operator=()

void operator= ( const acousticDampingSource &  )
delete

◆ addSup() [1/3]

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

Reimplemented from option.

Definition at line 112 of file acousticDampingSource.C.

References mesh, fvMatrix::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

Reimplemented from option.

Definition at line 130 of file acousticDampingSource.C.

References mesh, fvMatrix::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

Reimplemented from option.

Definition at line 149 of file acousticDampingSource.C.

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

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Reimplemented from cellSetOption.

Definition at line 168 of file acousticDampingSource.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ blendFactor_

volScalarField blendFactor_
protected

Definition at line 185 of file acousticDampingSource.H.

Referenced by acousticDampingSource::setBlendingFactor().

◆ frequency_

dimensionedScalar frequency_
protected

Definition at line 188 of file acousticDampingSource.H.

◆ x0_

point x0_
protected

Definition at line 191 of file acousticDampingSource.H.

Referenced by acousticDampingSource::setBlendingFactor().

◆ r1_

scalar r1_
protected

Definition at line 194 of file acousticDampingSource.H.

Referenced by acousticDampingSource::setBlendingFactor().

◆ r2_

scalar r2_
protected

Definition at line 197 of file acousticDampingSource.H.

Referenced by acousticDampingSource::setBlendingFactor().

◆ URefName_

word URefName_
protected

Definition at line 200 of file acousticDampingSource.H.

◆ w_

label w_
protected

Definition at line 203 of file acousticDampingSource.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17