Public Member Functions | Public Attributes | List of all members
phaseSystem::alphaControl Struct Reference

alpha solution control structure More...

Collaboration diagram for phaseSystem::alphaControl:
Collaboration graph
[legend]

Public Member Functions

void read (const dictionary &dict)
 Read the alpha and MULES controls from dict. More...
 
void correct (const scalar CoNum)
 Correct nAlphaSubCycles for the current Courant number. More...
 

Public Attributes

autoPtr< Function1< scalar > > nAlphaSubCyclesPtr
 Function to calculate the number of explicit MULES sub-cycles. More...
 
label nAlphaSubCycles
 Number of alpha equation sub-cycles. More...
 
label nAlphaCorr
 Number of alpha correctors. More...
 
bool MULESCorr
 Semi-implicit MULES switch. More...
 
scalar MULESCorrRelax
 Explicit correction relaxation factor (defaults to 0.5) More...
 
scalar vDotResidualAlpha
 Compressibility source stabilisation tolerance. More...
 
MULES::control MULES
 MULES controls. More...
 
Switch clip
 Optionally clip the phase-fractions. More...
 

Detailed Description

alpha solution control structure

Definition at line 80 of file phaseSystem.H.

Member Function Documentation

◆ read()

void read ( const dictionary &  dict)

Read the alpha and MULES controls from dict.

Definition at line 415 of file phaseSystem.C.

References dict, Foam::dimless, Foam::e, dictionary::found(), dictionary::lookupOrDefault(), dictionary::lookupOrDefaultBackwardsCompatible(), and Function1< Type >::New().

Referenced by multiphaseEuler::read().

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

◆ correct()

void correct ( const scalar  CoNum)

Correct nAlphaSubCycles for the current Courant number.

Definition at line 446 of file phaseSystem.C.

References CoNum.

Member Data Documentation

◆ nAlphaSubCyclesPtr

autoPtr<Function1<scalar> > nAlphaSubCyclesPtr

Function to calculate the number of explicit MULES sub-cycles.

from the alpha Courant number

Definition at line 84 of file phaseSystem.H.

◆ nAlphaSubCycles

label nAlphaSubCycles

Number of alpha equation sub-cycles.

Definition at line 87 of file phaseSystem.H.

Referenced by phaseSystem::solve().

◆ nAlphaCorr

label nAlphaCorr

Number of alpha correctors.

Usually used to improve the accuracy at high Courant numbers with semi-implicit MULES, MULESCorr = true

Definition at line 92 of file phaseSystem.H.

Referenced by phaseSystem::solve().

◆ MULESCorr

bool MULESCorr

Semi-implicit MULES switch.

Definition at line 95 of file phaseSystem.H.

Referenced by phaseSystem::solve().

◆ MULESCorrRelax

scalar MULESCorrRelax

Explicit correction relaxation factor (defaults to 0.5)

Definition at line 98 of file phaseSystem.H.

Referenced by phaseSystem::solve().

◆ vDotResidualAlpha

scalar vDotResidualAlpha

Compressibility source stabilisation tolerance.

Definition at line 101 of file phaseSystem.H.

Referenced by phaseSystem::solve().

◆ MULES

MULES::control MULES

MULES controls.

Definition at line 104 of file phaseSystem.H.

Referenced by phaseSystem::solve().

◆ clip

Switch clip

Optionally clip the phase-fractions.

between their physical limits and to sum to 1. Defaults to false

Definition at line 109 of file phaseSystem.H.

Referenced by phaseSystem::solve().

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