Public Member Functions | List of all members
viscousDissipation Class Reference

Applies a viscous dissipation energy source to the energy equation. More...

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

Public Member Functions

 TypeName ("viscousDissipation")
 
 viscousDissipation (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 
 viscousDissipation (const viscousDissipation &)=delete
 
void operator= (const viscousDissipation &)=delete
 
virtual ~viscousDissipation ()=default
 
virtual void addSup (const volScalarField &rho, fvMatrix< scalar > &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< optionclone () const
 
virtual ~option ()=default
 
const wordname () const noexcept
 
const fvMeshmesh () const noexcept
 
const dictionarycoeffs () 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< 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< 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
 
virtual void writeFooter (Ostream &) const
 
virtual void writeData (Ostream &) const
 

Additional Inherited Members

- Static Public Member Functions inherited from option
static autoPtr< optionNew (const word &name, const dictionary &dict, const fvMesh &mesh)
 
- Public Attributes inherited from option
bool log
 
- Protected Member Functions inherited from option
void resetApplied ()
 
- Protected Attributes inherited from option
const word name_
 
const word modelType_
 
const fvMeshmesh_
 
dictionary dict_
 
dictionary coeffs_
 
wordList fieldNames_
 
List< boolapplied_
 
bool active_
 

Detailed Description

Applies a viscous dissipation energy source to the energy equation.

Sources applied to either of the below, if exist:

  e         | Internal energy                            [m2/s2]
  h         | Enthalphy                                  [m2/s2]
  field     | User-specified field

Required fields:

  U         | Velocity                                   [m/s]
  rho       | Fluid density (for compressible flows)     [kg/m3]
Usage
Minimal example by using constant/fvOptions:
viscousDissipation1
{
    // Mandatory entries (unmodifiable)
    type                 viscousDissipation;

    // Optional entries (unmodifiable)
    fields           (<fieldName>);
    U                <UName>;
    rho              <rhoName>;

    // Conditional optional entries (unmodifiable)

        // when rho=rhoInf
        rhoInf       1000;

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

where the entries mean:

Property Description Type Reqd Dflt
type Type name: viscousDissipation word yes -
fields Name of operand (energy) field word no -
U Name of operand velocity field word no U
rho Name of operand density field word no none
rhoInf Value of fluid density scalar cndtnl 0

The inherited entries are elaborated in:

Note
  • The entry fields accepts only a single field name.
  • The sources are applied onto the entire computational domain.
  • rho=rhoInf sets a zero-density for single phase flows.
  • Not applicable to multiphase flows.
Source files

Definition at line 143 of file viscousDissipation.H.

Constructor & Destructor Documentation

◆ viscousDissipation() [1/2]

viscousDissipation ( const word sourceName,
const word modelType,
const dictionary dict,
const fvMesh mesh 
)

Definition at line 78 of file viscousDissipation.C.

References basicThermo::dictName, Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::readEntry(), and option::resetApplied().

Here is the call graph for this function:

◆ viscousDissipation() [2/2]

viscousDissipation ( const viscousDissipation )
delete

◆ ~viscousDissipation()

virtual ~viscousDissipation ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "viscousDissipation"  )

◆ operator=()

void operator= ( const viscousDissipation )
delete

◆ addSup()

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

Reimplemented from option.

Definition at line 162 of file viscousDissipation.C.

References D, Foam::dimTime, Foam::fvc::grad(), Foam::inv(), tmp::New(), IOobject::NO_READ, IOobject::NO_WRITE, GeometricField::ref(), U, and Foam::Zero.

Here is the call graph for this function:

◆ read()

virtual bool read ( const dictionary dict)
inlinevirtual

Reimplemented from option.

Definition at line 208 of file viscousDissipation.H.


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