Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
SemiImplicitSource< Type > Class Template Reference
Numerics » Finite volume Options » Sources

Semi-implicit source, described using an input dictionary. The injection rate coefficients are specified as pairs of Su-Sp coefficients, i.e. More...

Collaboration diagram for SemiImplicitSource< Type >:
[legend]

Public Types

enum  volumeModeType { vmAbsolute, vmSpecific }
 Enumeration for volume types. More...
 

Public Member Functions

 TypeName ("SemiImplicitSource")
 Runtime type information. More...
 
 SemiImplicitSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
const volumeModeType & volumeMode () const
 Return const access to the volume mode. More...
 
volumeModeType & volumeMode ()
 Return access to the volume mode. More...
 
virtual void addSup (fvMatrix< Type > &eqn, const label fieldi)
 Add explicit contribution to equation. More...
 
virtual void addSup (const volScalarField &rho, fvMatrix< Type > &eqn, const label fieldi)
 Add explicit contribution to compressible equation. More...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 

Static Public Attributes

static const Enum< volumeModeType > volumeModeTypeNames_
 Word list of volume mode type names. More...
 

Protected Member Functions

void setFieldData (const dictionary &dict)
 Set the local field data. More...
 

Protected Attributes

volumeModeType volumeMode_
 Volume mode. More...
 
scalar VDash_
 Volume normalisation. More...
 
PtrList< Function1< Type > > Su_
 Source field values. More...
 
PtrList< Function1< scalar > > Sp_
 

Detailed Description

template<class Type>
class Foam::fv::SemiImplicitSource< Type >

Semi-implicit source, described using an input dictionary. The injection rate coefficients are specified as pairs of Su-Sp coefficients, i.e.

\[ S(x) = S_u + S_p x \]

where

\( S(x) \) = net source for field 'x'
\( S_u \) = explicit source contribution
\( S_p \) = linearised implicit contribution

Example of the source specification:

    volumeMode      absolute; // specific
    injectionRateSuSp
    {
        k           (30.7 0);
        epsilon     (1.5  0);
    }

Valid options for the volumeMode entry include:

  • absolute: values are given as <quantity>
  • specific: values are given as <quantity>/m3

The injectionRate can also be specified as a Function1 by having dictionaries for the field entries instead:

    injectionRateSuSp
    {
        k
        {
            // Time-ramp from 0 to 30.7 at time 5
            Su table
            (
                (0 0.0)
                (5 30.7)
            );
            Sp      0.0;
        }
        epsilon
        {
            Su      1.5;
            Sp      0.0;
        }
    }
See also
Foam::fvOption
Source files

Definition at line 123 of file SemiImplicitSource.H.

Member Enumeration Documentation

◆ volumeModeType

enum volumeModeType

Enumeration for volume types.

Enumerator
vmAbsolute 
vmSpecific 

Definition at line 147 of file SemiImplicitSource.H.

Constructor & Destructor Documentation

◆ SemiImplicitSource()

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

Construct from components.

Definition at line 113 of file SemiImplicitSource.C.

References dict, and Foam::blockMeshTools::read().

Here is the call graph for this function:

Member Function Documentation

◆ setFieldData()

void setFieldData ( const dictionary &  dict)
protected

Set the local field data.

Definition at line 52 of file SemiImplicitSource.C.

References Foam::BitOps::count(), dict, Tuple2< T1, T2 >::first(), Tuple2< T1, T2 >::second(), and dictionary::set().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "SemiImplicitSource< Type >"  )

Runtime type information.

◆ volumeMode() [1/2]

const Foam::fv::SemiImplicitSource< Type >::volumeModeType & volumeMode ( ) const
inline

Return const access to the volume mode.

Definition at line 34 of file SemiImplicitSourceI.H.

◆ volumeMode() [2/2]

Foam::fv::SemiImplicitSource< Type >::volumeModeType & volumeMode ( )
inline

Return access to the volume mode.

Definition at line 42 of file SemiImplicitSourceI.H.

◆ addSup() [1/2]

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

Add explicit contribution to equation.

Definition at line 132 of file SemiImplicitSource.C.

References Foam::expressions::patchExpr::debug, fvMatrix< Type >::dimensions(), Foam::dimVolume, Foam::endl(), Foam::Info, psi, fvMatrix< Type >::psi(), Sp, Su, Foam::fam::SuSp(), and Foam::Zero.

Here is the call graph for this function:

◆ addSup() [2/2]

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

Add explicit contribution to compressible equation.

Definition at line 187 of file SemiImplicitSource.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), and Foam::Info.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Read source dictionary.

Definition at line 204 of file SemiImplicitSource.C.

References dict, and Foam::blockMeshTools::read().

Here is the call graph for this function:

Member Data Documentation

◆ volumeModeTypeNames_

const Foam::Enum< typename Foam::fv::SemiImplicitSource< Type >::volumeModeType > volumeModeTypeNames_
static

Word list of volume mode type names.

Definition at line 154 of file SemiImplicitSource.H.

◆ volumeMode_

volumeModeType volumeMode_
protected

Volume mode.

Definition at line 162 of file SemiImplicitSource.H.

◆ VDash_

scalar VDash_
protected

Volume normalisation.

Definition at line 165 of file SemiImplicitSource.H.

◆ Su_

PtrList<Function1<Type> > Su_
protected

Source field values.

Definition at line 168 of file SemiImplicitSource.H.

◆ Sp_

PtrList<Function1<scalar> > Sp_
protected

Definition at line 169 of file SemiImplicitSource.H.

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