All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
blendingMethod Class Referenceabstract

Abstract base class for functions that are used to combine interfacial sub-models according to the volume fractions of the phases that they apply to. More...

Inheritance diagram for blendingMethod:
Collaboration diagram for blendingMethod:

Public Member Functions

 TypeName ("blendingMethod")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, blendingMethod, dictionary,(const dictionary &dict, const phaseInterface &interface),(dict, interface))
 
 blendingMethod (const dictionary &dict, const phaseInterface &interface)
 Construct from a dictionary and an interface. More...
 
virtual ~blendingMethod ()
 Destructor. More...
 
virtual bool canBeContinuous (const label index) const =0
 Return whether or not a phase can be considered continuous. More...
 
virtual bool canSegregate () const =0
 Return whether or not this interface can segregate. More...
 
tmp< volScalarFieldf1DispersedIn2 (const UPtrList< const volScalarField > &alphas) const
 Return the coefficient for models in which phase 1 is dispersed in. More...
 
tmp< volScalarFieldf2DispersedIn1 (const UPtrList< const volScalarField > &alphas) const
 Return the coefficient for models in which phase 2 is dispersed in. More...
 
tmp< volScalarFieldfDisplaced (const UPtrList< const volScalarField > &alphas) const
 Return the coefficient for when the interface is displaced by a. More...
 

Static Public Member Functions

static autoPtr< blendingMethodNew (const word &modelTypeName, const dictionary &dict, const phaseInterface &interface)
 

Protected Member Functions

tmp< volScalarFieldconstant (const UPtrList< const volScalarField > &alphas, const scalar k) const
 Return a constant field with the given value. More...
 
tmp< volScalarFieldalpha (const UPtrList< const volScalarField > &alphas, const label set, const bool protect) const
 Get the volume fraction of the given set. More...
 
tmp< volScalarFieldparameter (const UPtrList< const volScalarField > &alphas, const label set, const Pair< scalar > &parameters) const
 Get a blending parameter averaged for the given set. More...
 
tmp< volScalarFieldx (const UPtrList< const volScalarField > &alphas, const label phaseSet, const label systemSet) const
 Return the coordinate of the blending function. More...
 
virtual tmp< volScalarFieldfContinuous (const UPtrList< const volScalarField > &alphas, const label phaseSet, const label systemSet) const =0
 Evaluate the blending function for sets in which all phases can be. More...
 
virtual tmp< volScalarFieldf (const UPtrList< const volScalarField > &alphas, const label phaseSet, const label systemSet) const
 Evaluate the blending function. Filters out phases that cannot. More...
 

Static Protected Member Functions

static scalar readParameter (const word &name, const dictionary &dict, const Pair< scalar > &bounds, const bool allowNone)
 Read a parameter and check it lies within specified bounds. More...
 
static Pair< scalar > readParameters (const word &name, const dictionary &dict, const phaseInterface &interface, const Pair< scalar > &bounds, const bool allowNone)
 Read a parameter for each phase in the interface. More...
 
static bool isParameter (const scalar parameter)
 Test if the given scalar is a valid parameter. More...
 

Protected Attributes

const phaseInterface interface_
 Interface. More...
 

Detailed Description

Abstract base class for functions that are used to combine interfacial sub-models according to the volume fractions of the phases that they apply to.

Source files

Definition at line 51 of file blendingMethod.H.

Constructor & Destructor Documentation

◆ blendingMethod()

blendingMethod ( const dictionary dict,
const phaseInterface interface 
)

Construct from a dictionary and an interface.

◆ ~blendingMethod()

virtual ~blendingMethod ( )
virtual

Destructor.

Member Function Documentation

◆ readParameter()

static scalar readParameter ( const word name,
const dictionary dict,
const Pair< scalar > &  bounds,
const bool  allowNone 
)
staticprotected

Read a parameter and check it lies within specified bounds.

◆ readParameters()

static Pair<scalar> readParameters ( const word name,
const dictionary dict,
const phaseInterface interface,
const Pair< scalar > &  bounds,
const bool  allowNone 
)
staticprotected

Read a parameter for each phase in the interface.

◆ isParameter()

static bool isParameter ( const scalar  parameter)
staticprotected

Test if the given scalar is a valid parameter.

◆ constant()

tmp<volScalarField> constant ( const UPtrList< const volScalarField > &  alphas,
const scalar  k 
) const
protected

Return a constant field with the given value.

◆ alpha()

tmp<volScalarField> alpha ( const UPtrList< const volScalarField > &  alphas,
const label  set,
const bool  protect 
) const
protected

Get the volume fraction of the given set.

◆ parameter()

tmp<volScalarField> parameter ( const UPtrList< const volScalarField > &  alphas,
const label  set,
const Pair< scalar > &  parameters 
) const
protected

Get a blending parameter averaged for the given set.

◆ x()

tmp<volScalarField> x ( const UPtrList< const volScalarField > &  alphas,
const label  phaseSet,
const label  systemSet 
) const
protected

Return the coordinate of the blending function.

◆ fContinuous()

virtual tmp<volScalarField> fContinuous ( const UPtrList< const volScalarField > &  alphas,
const label  phaseSet,
const label  systemSet 
) const
protectedpure virtual

Evaluate the blending function for sets in which all phases can be.

continuous

Implemented in hyperbolic, linear, continuous, and segregated.

◆ f()

virtual tmp<volScalarField> f ( const UPtrList< const volScalarField > &  alphas,
const label  phaseSet,
const label  systemSet 
) const
protectedvirtual

Evaluate the blending function. Filters out phases that cannot.

become continuous from the sets, then calls fContinuous

◆ TypeName()

TypeName ( "blendingMethod"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
blendingMethod  ,
dictionary  ,
(const dictionary &dict, const phaseInterface &interface)  ,
(dict, interface)   
)

◆ New()

static autoPtr<blendingMethod> New ( const word modelTypeName,
const dictionary dict,
const phaseInterface interface 
)
static

◆ canBeContinuous()

virtual bool canBeContinuous ( const label  index) const
pure virtual

Return whether or not a phase can be considered continuous.

Implemented in hyperbolic, linear, continuous, and segregated.

◆ canSegregate()

virtual bool canSegregate ( ) const
pure virtual

Return whether or not this interface can segregate.

Implemented in hyperbolic, linear, continuous, and segregated.

◆ f1DispersedIn2()

tmp<volScalarField> f1DispersedIn2 ( const UPtrList< const volScalarField > &  alphas) const

Return the coefficient for models in which phase 1 is dispersed in.

phase 2

◆ f2DispersedIn1()

tmp<volScalarField> f2DispersedIn1 ( const UPtrList< const volScalarField > &  alphas) const

Return the coefficient for models in which phase 2 is dispersed in.

phase 1

◆ fDisplaced()

tmp<volScalarField> fDisplaced ( const UPtrList< const volScalarField > &  alphas) const

Return the coefficient for when the interface is displaced by a.

third phase

Member Data Documentation

◆ interface_

const phaseInterface interface_
protected

Interface.

Definition at line 58 of file blendingMethod.H.


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