volumeFractionSource Class Reference

This option adds transport terms into the equations to account for the presence of a constant volume fraction. The volume fraction is read from constant/alpha.<phase>, where <phase> is given as a parameter to the option. Both advective and diffusive terms are added, and the resulting solution is time-accurate. The flux and velocity are treated as superficial. More...

Inheritance diagram for volumeFractionSource:
Collaboration diagram for volumeFractionSource:

Public Member Functions

 TypeName ("volumeFractionSource")
 Runtime type information. More...
 
 volumeFractionSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
 volumeFractionSource (const volumeFractionSource &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~volumeFractionSource ()
 Destructor. More...
 
virtual void addSup (fvMatrix< scalar > &, const label)
 
virtual void addSup (fvMatrix< vector > &, const label)
 
virtual void addSup (fvMatrix< symmTensor > &, const label)
 
virtual void addSup (fvMatrix< sphericalTensor > &, const label)
 
virtual void addSup (fvMatrix< tensor > &, const label)
 
virtual void addSup (const volScalarField &, fvMatrix< scalar > &, const label)
 
virtual void addSup (const volScalarField &, fvMatrix< vector > &, const label)
 
virtual void addSup (const volScalarField &, fvMatrix< symmTensor > &, const label)
 
virtual void addSup (const volScalarField &, fvMatrix< sphericalTensor > &, const label)
 
virtual void addSup (const volScalarField &, fvMatrix< tensor > &, const label)
 
virtual void addSup (const volScalarField &, const volScalarField &, fvMatrix< scalar > &, const label)
 
virtual void addSup (const volScalarField &, const volScalarField &, fvMatrix< vector > &, const label)
 
virtual void addSup (const volScalarField &, const volScalarField &, fvMatrix< symmTensor > &, const label)
 
virtual void addSup (const volScalarField &, const volScalarField &, fvMatrix< sphericalTensor > &, const label)
 
virtual void addSup (const volScalarField &, const volScalarField &, fvMatrix< tensor > &, const label)
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
void operator= (const volumeFractionSource &)=delete
 Disallow default bitwise assignment. 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< optionclone () const
 Return clone. More...
 
virtual ~option ()
 Destructor. More...
 
const wordname () const
 Return const access to the source name. More...
 
const fvMeshmesh () const
 Return const access to the mesh database. More...
 
const dictionarycoeffs () 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...
 
Switchactive ()
 Return access to the source active flag. More...
 
virtual bool isActive ()
 Is the source active? 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 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from option
static autoPtr< optionNew (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvOption model. More...
 
- Protected Attributes inherited from option
const word name_
 Source name. More...
 
const word modelType_
 Model type. More...
 
const fvMeshmesh_
 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...
 

Detailed Description

This option adds transport terms into the equations to account for the presence of a constant volume fraction. The volume fraction is read from constant/alpha.<phase>, where <phase> is given as a parameter to the option. Both advective and diffusive terms are added, and the resulting solution is time-accurate. The flux and velocity are treated as superficial.

This can be used to represent the effect of porous media that are caused purely by the reduction in volume of the fluid phase; i.e., additional blockage, and changes to transport and diffusion rates. It does not represent losses or transfers with the porous media. That requires separate sub-modelling.

Usage
Property Description Req'd? Default
phase Name of the phase associated with the volume fraction yes
phi Name of the flux field no phi
rho Name of the density field no rho
U Name of the velocity field no U
fields Names of the fields to apply the option to yes

Example specification:

    <fvOptionName>
    {
        type        volumeFractionSource;
        phase       solid;
        phi         phi;
        rho         rho;
        U           U;
        fields      (rho U e);
    }
Source files

Definition at line 116 of file volumeFractionSource.H.

Constructor & Destructor Documentation

◆ volumeFractionSource() [1/2]

volumeFractionSource ( const word name,
const word modelType,
const dictionary dict,
const fvMesh mesh 
)

Construct from components.

Definition at line 194 of file volumeFractionSource.C.

References alpha(), and Foam::read().

Here is the call graph for this function:

◆ volumeFractionSource() [2/2]

Disallow default bitwise copy construction.

◆ ~volumeFractionSource()

~volumeFractionSource ( )
virtual

Destructor.

Definition at line 213 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "volumeFractionSource"  )

Runtime type information.

◆ addSup() [1/15]

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

Reimplemented from option.

Definition at line 220 of file volumeFractionSource.C.

Referenced by volumeFractionSource::addSup(), and volumeFractionSource::~volumeFractionSource().

Here is the caller graph for this function:

◆ addSup() [2/15]

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

Reimplemented from option.

Definition at line 238 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [3/15]

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

Reimplemented from option.

Definition at line 267 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [4/15]

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

Reimplemented from option.

Definition at line 256 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [5/15]

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

Reimplemented from option.

Definition at line 278 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [6/15]

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

Reimplemented from option.

Definition at line 289 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [7/15]

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

Reimplemented from option.

Definition at line 308 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [8/15]

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

Reimplemented from option.

Definition at line 339 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [9/15]

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

Reimplemented from option.

Definition at line 327 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [10/15]

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

Reimplemented from option.

Definition at line 351 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [11/15]

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

Reimplemented from option.

Definition at line 363 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [12/15]

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

Reimplemented from option.

Definition at line 383 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [13/15]

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

Reimplemented from option.

Definition at line 416 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [14/15]

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

Reimplemented from option.

Definition at line 403 of file volumeFractionSource.C.

References volumeFractionSource::addSup().

Here is the call graph for this function:

◆ addSup() [15/15]

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

Reimplemented from option.

Definition at line 429 of file volumeFractionSource.C.

◆ read()

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from option.

Definition at line 441 of file volumeFractionSource.C.

References option::read(), and dictionary::readIfPresent().

Here is the call graph for this function:

◆ operator=()

void operator= ( const volumeFractionSource )
delete

Disallow default bitwise assignment.


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