walberla::free_surface::ExcessMassDistributionModel Class Reference

#include <ExcessMassDistributionModel.h>

Public Types

enum  ExcessMassModel {
  ExcessMassModel::EvenlyAllInterface, ExcessMassModel::EvenlyNewInterface, ExcessMassModel::EvenlyOldInterface, ExcessMassModel::WeightedAllInterface,
  ExcessMassModel::WeightedNewInterface, ExcessMassModel::WeightedOldInterface, ExcessMassModel::EvenlyAllInterfaceAndLiquid, ExcessMassModel::EvenlyAllInterfaceFallbackLiquid,
  ExcessMassModel::EvenlyNewInterfaceFallbackLiquid
}
 

Public Member Functions

 ExcessMassDistributionModel (const std::string &modelName)
 
 ExcessMassDistributionModel (const ExcessMassModel &modelType)
 
ExcessMassModel getModelType () const
 
std::string getModelName () const
 
std::string getFullModelSpecification () const
 
bool isEvenlyType () const
 
bool isWeightedType () const
 
bool isEvenlyAllInterfaceFallbackLiquidType () const
 

Static Public Member Functions

static std::initializer_list< const ExcessMassModelgetTypeIterator ()
 

Private Member Functions

ExcessMassModel chooseType (const std::string &modelName)
 
std::string chooseName (ExcessMassModel const &modelType) const
 

Private Attributes

std::string modelName_
 
ExcessMassModel modelType_
 

Static Private Attributes

static constexpr std::initializer_list< const ExcessMassModellistOfAllEnums
 

Member Enumeration Documentation

◆ ExcessMassModel

Enumerator
EvenlyAllInterface 
EvenlyNewInterface 
EvenlyOldInterface 
WeightedAllInterface 
WeightedNewInterface 
WeightedOldInterface 
EvenlyAllInterfaceAndLiquid 
EvenlyAllInterfaceFallbackLiquid 
EvenlyNewInterfaceFallbackLiquid 

Constructor & Destructor Documentation

◆ ExcessMassDistributionModel() [1/2]

walberla::free_surface::ExcessMassDistributionModel::ExcessMassDistributionModel ( const std::string &  modelName)
inline

◆ ExcessMassDistributionModel() [2/2]

walberla::free_surface::ExcessMassDistributionModel::ExcessMassDistributionModel ( const ExcessMassModel modelType)
inline

Member Function Documentation

◆ chooseName()

std::string walberla::free_surface::ExcessMassDistributionModel::chooseName ( ExcessMassModel const &  modelType) const
inlineprivate

◆ chooseType()

ExcessMassModel walberla::free_surface::ExcessMassDistributionModel::chooseType ( const std::string &  modelName)
inlineprivate

◆ getFullModelSpecification()

std::string walberla::free_surface::ExcessMassDistributionModel::getFullModelSpecification ( ) const
inline

◆ getModelName()

std::string walberla::free_surface::ExcessMassDistributionModel::getModelName ( ) const
inline

◆ getModelType()

ExcessMassModel walberla::free_surface::ExcessMassDistributionModel::getModelType ( ) const
inline

◆ getTypeIterator()

static std::initializer_list< const ExcessMassModel > walberla::free_surface::ExcessMassDistributionModel::getTypeIterator ( )
inlinestatic

◆ isEvenlyAllInterfaceFallbackLiquidType()

bool walberla::free_surface::ExcessMassDistributionModel::isEvenlyAllInterfaceFallbackLiquidType ( ) const
inline

◆ isEvenlyType()

bool walberla::free_surface::ExcessMassDistributionModel::isEvenlyType ( ) const
inline

◆ isWeightedType()

bool walberla::free_surface::ExcessMassDistributionModel::isWeightedType ( ) const
inline

Member Data Documentation

◆ listOfAllEnums

◆ modelName_

std::string walberla::free_surface::ExcessMassDistributionModel::modelName_
private

◆ modelType_

ExcessMassModel walberla::free_surface::ExcessMassDistributionModel::modelType_
private

The documentation for this class was generated from the following file:
@ WeightedNewInterface
@ EvenlyAllInterfaceFallbackLiquid
@ EvenlyNewInterfaceFallbackLiquid
@ EvenlyAllInterfaceAndLiquid
@ WeightedOldInterface
@ EvenlyNewInterface
@ WeightedAllInterface
@ EvenlyOldInterface
@ EvenlyAllInterface