multiphaseEuler Class Reference

Solver module for a system of any number of compressible fluid phases with a common pressure, but otherwise separate properties. The type of phase model is run time selectable and can optionally represent multiple species and in-phase reactions. The phase system is also run time selectable and can optionally represent different types of momentum, heat and mass transfer. More...

Inheritance diagram for multiphaseEuler:
Collaboration diagram for multiphaseEuler:

Public Member Functions

 TypeName ("multiphaseEuler")
 Runtime type information. More...
 
 multiphaseEuler (fvMesh &mesh)
 Construct from region mesh. More...
 
 multiphaseEuler (const multiphaseEuler &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~multiphaseEuler ()
 Destructor. More...
 
virtual void preSolve ()
 Called at the start of the time-step, before the PIMPLE loop. More...
 
virtual void moveMesh ()
 Called at the start of the PIMPLE loop to move the mesh. More...
 
virtual void prePredictor ()
 Called at the start of the PIMPLE loop. More...
 
virtual void momentumPredictor ()
 Construct and optionally solve the momentum equation. More...
 
virtual void thermophysicalPredictor ()
 Construct and solve the energy equation,. More...
 
virtual void pressureCorrector ()
 Construct and solve the pressure equation in the PISO loop. More...
 
virtual void postCorrector ()
 Correct the momentum and thermophysical transport modelling. More...
 
virtual void postSolve ()
 Called after the PIMPLE loop at the end of the time-step. More...
 
void operator= (const multiphaseEuler &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fluidSolver
 TypeName ("fluidSolver")
 Runtime type information. More...
 
 fluidSolver (fvMesh &mesh)
 Construct from region mesh. More...
 
 fluidSolver (const fluidSolver &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fluidSolver ()
 Destructor. More...
 
virtual scalar maxDeltaT () const
 Return the current maximum time-step for stable solution. More...
 
void operator= (const fluidSolver &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from solver
 TypeName ("solver")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, solver, fvMesh,(fvMesh &mesh),(mesh))
 
 solver (fvMesh &mesh)
 Construct from region mesh. More...
 
 solver (const solver &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~solver ()
 Destructor. More...
 
bool transient () const
 
Foam::fvModelsfvModels () const
 Return the fvModels that are created on demand. More...
 
Foam::fvConstraintsfvConstraints () const
 Return the fvConstraints that are created on demand. More...
 
void operator= (const solver &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the registry? More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
const fileNamecaseName (const bool global) const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 

Public Attributes

const phaseSystemfluid
 Reference to the multiphase fluid. More...
 
const phaseSystem::phaseModelListphases
 Reference to the phases. More...
 
const volScalarFieldp
 Reference to the pressure field. More...
 
const surfaceScalarFieldphi
 Reference to the mass-flux field. More...
 
- Public Attributes inherited from solver
const fvMeshmesh
 Region mesh. More...
 
const TimerunTime
 Time. More...
 
pimpleNoLoopControl pimple
 PIMPLE inner-loop controls. More...
 

Protected Member Functions

void readControls ()
 Read controls. More...
 
- Protected Member Functions inherited from fluidSolver
void readControls ()
 Read controls. More...
 
void meshCourantNo () const
 Check mesh Courant numbers for moving mesh cases. More...
 
void correctCoNum (const surfaceScalarField &phi)
 Correct the cached Courant numbers. More...
 
void correctCoNum (const volScalarField &rho, const surfaceScalarField &phi)
 Correct the cached Courant numbers. More...
 
void continuityErrors (const surfaceScalarField &phi)
 Calculate and print the continuity errors. More...
 
void continuityErrors (const volScalarField &rho, const volScalarField &thermoRho, const surfaceScalarField &phi)
 Calculate and print the continuity errors. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 

Protected Attributes

Switch faceMomentum
 Cell/face momentum equation switch. More...
 
Switch dragCorrection
 Cell/face drag correction for cell momentum corrector. More...
 
Switch partialElimination
 Partial elimination drag contribution optimisation. More...
 
int nEnergyCorrectors
 Number of energy correctors. More...
 
tmp< volScalarFieldtrDeltaT
 Optional LTS reciprocal time-step field. More...
 
tmp< surfaceScalarFieldtrDeltaTf
 Optional LTS reciprocal face time-step field. More...
 
solvers::buoyancy buoyancy
 Buoyancy force. More...
 
autoPtr< phaseSystemfluidPtr_
 
phaseSystemfluid_
 
phaseSystem::phaseModelListphases_
 
surfaceScalarFieldphi_
 
volScalarFieldp_
 
volScalarFieldp_rgh
 Reference to the buoyant pressure for buoyant cases. More...
 
Foam::pressureReference pressureReference
 Pressure reference. More...
 
const IOMRFZoneListMRF
 
PtrList< fvVectorMatrixUEqns
 Temporary phase momentum matrices. More...
 
PtrList< volScalarFieldrAUs
 Temporary storage for the reciprocal momentum equation diagonal. More...
 
PtrList< surfaceScalarFieldrAUfs
 Temporary storage for the reciprocal momentum equation diagonal. More...
 
autoPtr< volScalarFielddivU
 Stored divU from the previous mesh so that it can be. More...
 
- Protected Attributes inherited from fluidSolver
bool correctPhi
 Switch to correct the flux after mesh change. More...
 
scalar CoNum
 Current maximum Courant number for time-step control. More...
 
- Protected Attributes inherited from solver
fvMeshmesh_
 Region mesh. More...
 
bool steady
 Switch for steady-state. More...
 
bool LTS
 Switch for local time step transient operation. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState { GOOD , BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Member Functions inherited from solver
static autoPtr< solverNew (const word &solverName, fvMesh &mesh)
 Select, construct and return the solver. More...
 
static void load (const word &solverName)
 Load the specified solver library. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Attributes inherited from solver
static scalar deltaTFactor = 1.2
 deltaT increase factor More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 

Detailed Description

Solver module for a system of any number of compressible fluid phases with a common pressure, but otherwise separate properties. The type of phase model is run time selectable and can optionally represent multiple species and in-phase reactions. The phase system is also run time selectable and can optionally represent different types of momentum, heat and mass transfer.

Uses the flexible PIMPLE (PISO-SIMPLE) solution for time-resolved and pseudo-transient and steady simulations.

Optional fvModels and fvConstraints are provided to enhance the simulation in many ways including adding various sources, Lagrangian particles, surface film etc. and constraining or limiting the solution.

Source files
See also
Foam::solvers::compressibleVoF Foam::solvers::fluidSolver Foam::solvers::incompressibleFluid

Definition at line 70 of file multiphaseEuler.H.

Constructor & Destructor Documentation

◆ multiphaseEuler() [1/2]

multiphaseEuler ( fvMesh mesh)

Construct from region mesh.

Definition at line 94 of file multiphaseEuler.C.

References solver::mesh, IOobject::name(), multiphaseEuler::p_rgh, multiphaseEuler::readControls(), fvMesh::schemes(), and fvSchemes::setFluxRequired().

Here is the call graph for this function:

◆ multiphaseEuler() [2/2]

multiphaseEuler ( const multiphaseEuler )
delete

Disallow default bitwise copy construction.

◆ ~multiphaseEuler()

~multiphaseEuler ( )
virtual

Destructor.

Definition at line 200 of file multiphaseEuler.C.

Member Function Documentation

◆ readControls()

void readControls ( )
protected

◆ TypeName()

TypeName ( "multiphaseEuler"  )

Runtime type information.

◆ preSolve()

void preSolve ( )
virtual

Called at the start of the time-step, before the PIMPLE loop.

Implements solver.

Definition at line 206 of file multiphaseEuler.C.

References Foam::fvc::absolute(), correctPhi, Foam::fvc::div(), fvModels(), fvModels::preUpdateMesh(), and isothermalFluid::U.

Here is the call graph for this function:

◆ moveMesh()

◆ prePredictor()

void prePredictor ( )
virtual

Called at the start of the PIMPLE loop.

Implements solver.

Definition at line 243 of file multiphaseEuler.C.

References pimple().

Here is the call graph for this function:

◆ momentumPredictor()

void momentumPredictor ( )
virtual

Construct and optionally solve the momentum equation.

Implements solver.

Definition at line 116 of file momentumPredictor.C.

References pimple().

Here is the call graph for this function:

◆ thermophysicalPredictor()

void thermophysicalPredictor ( )
virtual

Construct and solve the energy equation,.

convert to temperature and update thermophysical and transport properties

Implements solver.

Definition at line 113 of file thermophysicalPredictor.C.

References Foam::endl(), forAll, Foam::Info, Foam::max(), Foam::min(), phaseModel::name(), pimple(), basicThermo::T(), and phaseModel::thermo().

Here is the call graph for this function:

◆ pressureCorrector()

void pressureCorrector ( )
virtual

Construct and solve the pressure equation in the PISO loop.

Implements solver.

Definition at line 30 of file pressureCorrector.C.

References phaseSystem::correctKinematics(), multiphaseEuler::faceMomentum, fluidSolutionControl::flow(), multiphaseEuler::fluid_, forAll, multiphaseEuler::p_rgh, multiphaseEuler::phases_, and solver::pimple.

Here is the call graph for this function:

◆ postCorrector()

void postCorrector ( )
virtual

Correct the momentum and thermophysical transport modelling.

Implements solver.

Definition at line 259 of file multiphaseEuler.C.

References pimple().

Here is the call graph for this function:

◆ postSolve()

void postSolve ( )
virtual

Called after the PIMPLE loop at the end of the time-step.

Implements solver.

Definition at line 269 of file multiphaseEuler.C.

◆ operator=()

void operator= ( const multiphaseEuler )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ faceMomentum

Switch faceMomentum
protected

Cell/face momentum equation switch.

Defaults to false, i.e. uses the cell momentum equation

Definition at line 81 of file multiphaseEuler.H.

Referenced by multiphaseEuler::pressureCorrector(), and multiphaseEuler::readControls().

◆ dragCorrection

Switch dragCorrection
protected

Cell/face drag correction for cell momentum corrector.

Defaults to false

Definition at line 85 of file multiphaseEuler.H.

Referenced by multiphaseEuler::readControls().

◆ partialElimination

Switch partialElimination
protected

Partial elimination drag contribution optimisation.

Defaults to false

Definition at line 89 of file multiphaseEuler.H.

Referenced by multiphaseEuler::readControls().

◆ nEnergyCorrectors

int nEnergyCorrectors
protected

Number of energy correctors.

Used to improve stability of phase-change sibulations Defaults to 1

Definition at line 94 of file multiphaseEuler.H.

Referenced by multiphaseEuler::readControls().

◆ trDeltaT

tmp<volScalarField> trDeltaT
protected

Optional LTS reciprocal time-step field.

Definition at line 98 of file multiphaseEuler.H.

◆ trDeltaTf

tmp<surfaceScalarField> trDeltaTf
protected

Optional LTS reciprocal face time-step field.

Definition at line 101 of file multiphaseEuler.H.

◆ buoyancy

Buoyancy force.

Definition at line 104 of file multiphaseEuler.H.

◆ fluidPtr_

autoPtr<phaseSystem> fluidPtr_
protected

Definition at line 109 of file multiphaseEuler.H.

◆ fluid_

phaseSystem& fluid_
protected

◆ phases_

phaseSystem::phaseModelList& phases_
protected

Definition at line 113 of file multiphaseEuler.H.

Referenced by multiphaseEuler::pressureCorrector().

◆ phi_

surfaceScalarField& phi_
protected

Definition at line 115 of file multiphaseEuler.H.

◆ p_

volScalarField& p_
protected

Definition at line 120 of file multiphaseEuler.H.

◆ p_rgh

volScalarField& p_rgh
protected

Reference to the buoyant pressure for buoyant cases.

otherwise to the pressure

Definition at line 124 of file multiphaseEuler.H.

Referenced by multiphaseEuler::moveMesh(), multiphaseEuler::multiphaseEuler(), and multiphaseEuler::pressureCorrector().

◆ pressureReference

Pressure reference.

Definition at line 130 of file multiphaseEuler.H.

◆ MRF

const IOMRFZoneList& MRF
protected

Definition at line 135 of file multiphaseEuler.H.

◆ UEqns

PtrList<fvVectorMatrix> UEqns
protected

Temporary phase momentum matrices.

shared between the momentum predictor and pressure corrector

Definition at line 142 of file multiphaseEuler.H.

◆ rAUs

PtrList<volScalarField> rAUs
protected

Temporary storage for the reciprocal momentum equation diagonal.

Used by the phase-fraction predictor and pressure corrector

Definition at line 146 of file multiphaseEuler.H.

◆ rAUfs

PtrList<surfaceScalarField> rAUfs
protected

Temporary storage for the reciprocal momentum equation diagonal.

Used by the phase-fraction predictor and face pressure corrector

Definition at line 150 of file multiphaseEuler.H.

◆ divU

autoPtr<volScalarField> divU
protected

Stored divU from the previous mesh so that it can be.

mapped and used in correctPhi to ensure the corrected phi has the same divergence

Definition at line 155 of file multiphaseEuler.H.

Referenced by multiphaseEuler::moveMesh().

◆ fluid

Reference to the multiphase fluid.

Definition at line 203 of file multiphaseEuler.H.

◆ phases

Reference to the phases.

Definition at line 206 of file multiphaseEuler.H.

◆ p

const volScalarField& p

Reference to the pressure field.

Definition at line 209 of file multiphaseEuler.H.

◆ phi

const surfaceScalarField& phi

Reference to the mass-flux field.

Definition at line 212 of file multiphaseEuler.H.

Referenced by multiphaseEuler::moveMesh().


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