segregatedDisplacedSidedPhaseInterface Class Reference

Class to represent a certain side of an interface between phases, where one phase is considered segregated within the other, and the pair has been displaced to some extent by a third phase. More...

Inheritance diagram for segregatedDisplacedSidedPhaseInterface:
Collaboration diagram for segregatedDisplacedSidedPhaseInterface:

Public Member Functions

 TypeName ("segregatedDisplacedSidedPhaseInterface")
 Runtime type information. More...
 
 segregatedDisplacedSidedPhaseInterface (const phaseModel &phase, const phaseModel &otherPhase, const phaseModel &displacing)
 Construct from phases. More...
 
 segregatedDisplacedSidedPhaseInterface (const phaseSystem &fluid, const word &name)
 Construct from fluid and name. More...
 
virtual ~segregatedDisplacedSidedPhaseInterface ()
 Destructor. More...
 
virtual word name () const
 Name. More...
 
- Public Member Functions inherited from segregatedPhaseInterface
 TypeName ("segregatedPhaseInterface")
 Runtime type information. More...
 
 segregatedPhaseInterface (const phaseModel &phase1, const phaseModel &phase2)
 Construct from phases. More...
 
 segregatedPhaseInterface (const phaseSystem &fluid, const word &name)
 Construct from fluid and name. More...
 
virtual ~segregatedPhaseInterface ()
 Destructor. More...
 
- Public Member Functions inherited from phaseInterface
 TypeName ("phaseInterface")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, phaseInterface, word,(const phaseSystem &fluid, const word &name),(fluid, name))
 
 phaseInterface (const phaseModel &phase1, const phaseModel &phase2)
 Construct from phases. More...
 
 phaseInterface (const Tuple2< const phaseModel &, const phaseModel &> &phases)
 Construct from phases. More...
 
 phaseInterface (const phaseSystem &fluid, const word &name)
 Construct from fluid and name. More...
 
 phaseInterface (const phaseSystem &fluid, const phaseInterfaceKey &name)
 Construct from fluid and key. More...
 
virtual autoPtr< phaseInterface > clone () const
 Clone function. More...
 
virtual ~phaseInterface ()
 Destructor. More...
 
template<class ModelType , class Derived >
const Derived & modelCast () const
 Cast to derived type for use in a model. More...
 
const phaseModel & phase1 () const
 Return phase 1. More...
 
const phaseModel & phase2 () const
 Return phase 2. More...
 
bool contains (const phaseModel &phase) const
 Return true if this phaseInterface contains the given phase. More...
 
const phaseModel & otherPhase (const phaseModel &phase) const
 Return the other phase relative to the given phase. More...
 
label index (const phaseModel &phase) const
 Return the index of the given phase. Generates a FatalError if. More...
 
const phaseSystem & fluid () const
 Return the phase system. More...
 
const fvMesh & mesh () const
 Return the mesh. More...
 
const uniformDimensionedVectorField & g () const
 Return gravitational acceleration. More...
 
tmp< volScalarField > rho () const
 Average density. More...
 
tmp< volScalarField > magUr () const
 Relative velocity magnitude. More...
 
tmp< volScalarField > sigma () const
 Surface tension coefficient. More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the pair More...
 
const_iterator cend () const
 const_iterator set to beyond the end of the pair More...
 
const_iterator begin () const
 const_iterator set to the beginning of the pair More...
 
const_iterator end () const
 const_iterator set to beyond the end of the pair More...
 
- Public Member Functions inherited from displacedPhaseInterface
 TypeName ("displacedPhaseInterface")
 Runtime type information. More...
 
 displacedPhaseInterface (const phaseModel &phase1, const phaseModel &phase2, const phaseModel &displacing)
 Construct from phases. More...
 
 displacedPhaseInterface (const phaseSystem &fluid, const word &name)
 Construct from fluid and name. More...
 
virtual ~displacedPhaseInterface ()
 Destructor. More...
 
const phaseModel & displacing () const
 Displacing phase. More...
 
- Public Member Functions inherited from sidedPhaseInterface
 TypeName ("sidedPhaseInterface")
 Runtime type information. More...
 
 sidedPhaseInterface (const phaseModel &phase, const phaseModel &otherPhase)
 Construct from phases. More...
 
 sidedPhaseInterface (const phaseSystem &fluid, const word &name)
 Construct from fluid and name. More...
 
virtual ~sidedPhaseInterface ()
 Destructor. More...
 
const phaseModel & phase () const
 Phase on the this side of the interface. More...
 
const phaseModel & otherPhase () const
 Phase on the other side of the interface. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from segregatedPhaseInterface
static word separator ()
 Return the separator that delimits this interface's name. More...
 
- Static Public Member Functions inherited from phaseInterface
static const phaseModel & getPhase1 (const phaseModel &phase1, const phaseModel &phase2)
 Get a reference to phase1 after sorting the phases by index. More...
 
static const phaseModel & getPhase2 (const phaseModel &phase1, const phaseModel &phase2)
 Get a reference to phase2 after sorting the phases by index. More...
 
static bool addHeadSeparator (const word &separator)
 Add a head separator to the list. More...
 
static bool addOldSeparatorToSeparator (const word &oldSeparator, const word &separator)
 Add a old separator to separator to the table. More...
 
static wordList nameToNameParts (const phaseSystem &fluid, const word &name)
 Split an interface name and return all its parts. More...
 
static wordList nameToSeparators (const phaseSystem &fluid, const word &name)
 Split an interface name and return its separators. More...
 
static word separatorsToTypeName (const wordList &separators)
 Convert a list of separators into a type name. More...
 
static word nameToTypeName (const phaseSystem &fluid, const word &name)
 Convert an interface name into a type name. Essentially just. More...
 
static word namePartsToName (const phaseSystem &fluid, const wordList &nameParts)
 Convert interface name parts to an interface name. More...
 
static word oldNamePartsToName (const phaseSystem &fluid, const wordList &oldNameParts)
 Convert old-format interface name parts to an interface name. Used. More...
 
static Tuple2< const phaseModel &, const phaseModel & > identifyPhases (const phaseSystem &fluid, const word &name, const wordList &separators)
 Return references to the phases associated with a given name, and a. More...
 
static autoPtr< phaseInterface > New (const phaseSystem &fluid, const word &name)
 Select given fluid and name. More...
 
static autoPtr< phaseInterface > New (const phaseInterface &interface1, const phaseInterface &interface2)
 Select by combining two interfaces. More...
 
static word separator ()
 Return the separator that delimits this interface's name. More...
 
- Static Public Member Functions inherited from displacedPhaseInterface
static word separator ()
 Return the separator that delimits this interface's name. More...
 
- Static Public Member Functions inherited from sidedPhaseInterface
static word separator ()
 Return the separator that delimits this interface's name. More...
 

Detailed Description

Class to represent a certain side of an interface between phases, where one phase is considered segregated within the other, and the pair has been displaced to some extent by a third phase.

Source files

Definition at line 52 of file segregatedDisplacedSidedPhaseInterface.H.

Constructor & Destructor Documentation

◆ segregatedDisplacedSidedPhaseInterface() [1/2]

segregatedDisplacedSidedPhaseInterface ( const phaseModel &  phase,
const phaseModel &  otherPhase,
const phaseModel &  displacing 
)

Construct from phases.

◆ segregatedDisplacedSidedPhaseInterface() [2/2]

segregatedDisplacedSidedPhaseInterface ( const phaseSystem &  fluid,
const word &  name 
)

Construct from fluid and name.

◆ ~segregatedDisplacedSidedPhaseInterface()

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "segregatedDisplacedSidedPhaseInterface"  )

Runtime type information.

◆ name()

virtual word name ( ) const
virtual

Name.

Reimplemented from displacedPhaseInterface.


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