All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
hyperbolic Class Reference

Blending method based on smooth hyperbolic functions. Supports the full range of phase fraction space. E.g., from droplets in air, through a segregated regime, to bubbly flow. More...

Inheritance diagram for hyperbolic:
Collaboration diagram for hyperbolic:

Public Member Functions

 TypeName ("hyperbolic")
 Runtime type information. More...
 
 hyperbolic (const dictionary &dict, const phaseInterface &interface)
 Construct from a dictionary and an interface. More...
 
 ~hyperbolic ()
 Destructor. More...
 
virtual bool canBeContinuous (const label index) const
 Return whether or not a phase can be considered continuous. More...
 
virtual bool canSegregate () const
 Return whether or not this interface can segregate. More...
 
- Public Member Functions inherited from blendingMethod
 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...
 
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...
 

Protected Member Functions

virtual tmp< volScalarFieldfContinuous (const UPtrList< const volScalarField > &alphas, const label phaseSet, const label systemSet) const
 Evaluate the blending function. More...
 
- Protected Member Functions inherited from blendingMethod
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< volScalarFieldf (const UPtrList< const volScalarField > &alphas, const label phaseSet, const label systemSet) const
 Evaluate the blending function. Filters out phases that cannot. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from blendingMethod
static autoPtr< blendingMethodNew (const word &modelTypeName, const dictionary &dict, const phaseInterface &interface)
 
- Static Protected Member Functions inherited from blendingMethod
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 inherited from blendingMethod
const phaseInterface interface_
 Interface. More...
 

Detailed Description

Blending method based on smooth hyperbolic functions. Supports the full range of phase fraction space. E.g., from droplets in air, through a segregated regime, to bubbly flow.

This method requires a volume fraction at which the phase is considered to become continuous, and a range of volume fraction over which this occurs, to be specified for both phases.

Alternatively, the volume fraction can be omitted or replaced with the keyword "none" to represent a phase which cannot become continuous. E.g., a particulate phase.

Source files

Definition at line 60 of file hyperbolic.H.

Constructor & Destructor Documentation

◆ hyperbolic()

hyperbolic ( const dictionary dict,
const phaseInterface interface 
)

Construct from a dictionary and an interface.

◆ ~hyperbolic()

~hyperbolic ( )

Destructor.

Member Function Documentation

◆ fContinuous()

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

Evaluate the blending function.

Implements blendingMethod.

◆ TypeName()

TypeName ( "hyperbolic"  )

Runtime type information.

◆ canBeContinuous()

virtual bool canBeContinuous ( const label  index) const
virtual

Return whether or not a phase can be considered continuous.

Implements blendingMethod.

◆ canSegregate()

virtual bool canSegregate ( ) const
virtual

Return whether or not this interface can segregate.

Implements blendingMethod.


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