Loading...
Searching...
No Matches
viscousDissipation Class Reference
Numerics » Finite volume Options » Sources

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

#include <viscousDissipation.H>

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

Public Member Functions

 TypeName ("viscousDissipation")
 Runtime type information.
 viscousDissipation (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from explicit source name and mesh.
 viscousDissipation (const viscousDissipation &)=delete
 No copy construct.
void operator= (const viscousDissipation &)=delete
 No copy assignment.
virtual ~viscousDissipation ()=default
 Destructor.
virtual void addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
 Add explicit contribution to compressible energy equation.
virtual bool read (const dictionary &dict)
 Read source dictionary - no-op.
Public Member Functions inherited from option
 TypeName ("option")
 Runtime type information.
 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.
autoPtr< option > clone () const
 Return clone.
virtual ~option ()=default
 Destructor.
const word & name () const noexcept
 Return const access to the source name.
const fvMesh & mesh () const noexcept
 Return const access to the mesh database.
const dictionary & coeffs () const noexcept
 Return dictionary.
bool active () const noexcept
 True if source is active.
void setApplied (const label fieldi)
 Set the applied flag to true for field index fieldi.
bool active (const bool on) noexcept
 Change source active flag, return previous value.
virtual bool isActive ()
 Is the source active?
virtual label applyToField (const word &fieldName) const
 Return index of field name if found in fieldNames list.
virtual void checkApplied () const
 Check that the source has been applied.
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 correct (surfaceScalarField &field)
virtual void correct (surfaceVectorField &field)
virtual void correct (surfaceTensorField &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 postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void writeHeader (Ostream &) const
 Write the source header information.
virtual void writeFooter (Ostream &) const
 Write the source footer information.
virtual void writeData (Ostream &) const
 Write the source properties.

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.
Public Attributes inherited from option
bool log
 Switch write log to Info.
Protected Member Functions inherited from option
void resetApplied ()
 Resize/reset applied flag list for all fieldNames_ entries.
Protected Attributes inherited from option
const word name_
 Source name.
const word modelType_
 Model type.
const fvMesh & mesh_
 Reference to the mesh database.
dictionary dict_
 Top level source dictionary.
dictionary coeffs_
 Dictionary containing source coefficients.
wordList fieldNames_
 Field names to apply source to - populated by derived models.
List< bool > applied_
 Applied flag list - corresponds to each fieldNames_ entry.
bool active_
 Source active flag.

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 )

Construct from explicit source name and mesh.

Definition at line 71 of file viscousDissipation.C.

References option::coeffs_, dict, basicThermo::dictName, Foam::dimDensity, option::fieldNames_, if(), option::mesh(), option::mesh_, option::option(), and option::resetApplied().

Referenced by operator=(), and viscousDissipation().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ viscousDissipation() [2/2]

viscousDissipation ( const viscousDissipation & )
delete

No copy construct.

References viscousDissipation().

Here is the call graph for this function:

◆ ~viscousDissipation()

virtual ~viscousDissipation ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "viscousDissipation" )

Runtime type information.

References dict, and option::mesh().

Here is the call graph for this function:

◆ operator=()

void operator= ( const viscousDissipation & )
delete

No copy assignment.

References viscousDissipation().

Here is the call graph for this function:

◆ addSup()

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

Add explicit contribution to compressible energy equation.

Reimplemented from option.

Definition at line 155 of file viscousDissipation.C.

References D, Foam::dimTime, Foam::fvc::grad(), Foam::inv(), option::mesh_, IOobjectOption::NO_REGISTER, U, and Foam::Zero.

Here is the call graph for this function:

◆ read()

virtual bool read ( const dictionary & dict)
inlinevirtual

Read source dictionary - no-op.

Reimplemented from option.

Definition at line 232 of file viscousDissipation.H.

References dict.

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