svFSIplus
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ConstitutiveModelParameters Class Reference

The ConstitutiveModelParameters class store parameters for various constitutive models. More...

#include <Parameters.h>

Inheritance diagram for ConstitutiveModelParameters:
[legend]

Public Member Functions

void print_parameters ()
 
bool defined () const
 
void set_values (tinyxml2::XMLElement *modl_params)
 
- Public Member Functions inherited from ParameterLists
void set_xml_element_name (const std::string &name)
 
void set_parameter (const std::string &name, const bool value, bool required, Parameter< bool > &param)
 Set the name, default value and the parameter required flag. More...
 
void set_parameter (const std::string &name, const double value, bool required, Parameter< double > &param)
 
void set_parameter (const std::string &name, std::initializer_list< double > value, bool required, VectorParameter< double > &param)
 
void set_parameter (const std::string &name, std::initializer_list< int > value, bool required, VectorParameter< int > &param)
 
void set_parameter (const std::string &name, std::initializer_list< std::string > value, bool required, VectorParameter< std::string > &param)
 
void set_parameter (const std::string &name, const int value, bool required, Parameter< int > &param, std::vector< int > range={})
 
void set_parameter (const std::string &name, const std::string &value, bool required, Parameter< std::string > &param)
 
void set_parameter_value (const std::string &name, const std::string &value)
 Set the value of a paramter from a string. More...
 
void check_required ()
 Check if any required parameters have not been set. More...
 
std::map< std::string, std::string > get_parameter_list ()
 Get the defined parameters as a map of strings. More...
 
void print_parameter_list ()
 Print the parameters. More...
 

Public Attributes

Parameter< std::string > type
 
GuccioneParameters guccione
 
HolzapfelParameters holzapfel
 
HolzapfelGasserOgdenParameters holzapfel_gasser_ogden
 
LeeSacksParameters lee_sacks
 
MooneyRivlinParameters mooney_rivlin
 
NeoHookeanParameters neo_hookean
 
StVenantKirchhoffParameters stvenant_kirchhoff
 
bool value_set = false
 
- Public Attributes inherited from ParameterLists
std::map< std::string, std::variant< Parameter< bool > *, Parameter< double > *, Parameter< int > *, Parameter< std::string > *, VectorParameter< double > *, VectorParameter< int > *, VectorParameter< std::string > * > > params_map
 Map used for storing parameters by name / Parameter template union. More...
 
std::string xml_element_name = ""
 

Static Public Attributes

static const std::string xml_element_name_ = "Constitutive_model"
 Process parameters for various constitutive models. More...
 
static const std::string GUCCIONE_MODEL = "Guccione"
 
static const std::string HGO_MODEL = "HGO"
 
static const std::string HOLZAPFEL_OGDEN_MODEL = "HolzapfelOgden"
 
static const std::string HOLZAPFEL_OGDEN_MA_MODEL = "HolzapfelOgden-ModifiedAnisotropy"
 
static const std::string LEE_SACKS = "Lee-Sacks"
 
static const std::string NEOHOOKEAN_MODEL = "neoHookean"
 
static const std::string STVENANT_KIRCHHOFF_MODEL = "stVenantKirchhoff"
 
static const std::map< std::string, std::string > constitutive_model_types
 Supported constitutive model types and their aliases. More...
 

Detailed Description

The ConstitutiveModelParameters class store parameters for various constitutive models.

Member Data Documentation

◆ constitutive_model_types

const std::map< std::string, std::string > ConstitutiveModelParameters::constitutive_model_types
static
Initial value:
= {
{ ConstitutiveModelParameters::GUCCIONE_MODEL, ConstitutiveModelParameters::GUCCIONE_MODEL},
{ "Gucci", ConstitutiveModelParameters::GUCCIONE_MODEL},
{ConstitutiveModelParameters::HGO_MODEL, ConstitutiveModelParameters::HGO_MODEL},
{ConstitutiveModelParameters::HOLZAPFEL_OGDEN_MODEL, ConstitutiveModelParameters::HOLZAPFEL_OGDEN_MODEL},
{ConstitutiveModelParameters::HOLZAPFEL_OGDEN_MA_MODEL, ConstitutiveModelParameters::HOLZAPFEL_OGDEN_MA_MODEL},
{ConstitutiveModelParameters::LEE_SACKS, ConstitutiveModelParameters::LEE_SACKS},
{ConstitutiveModelParameters::NEOHOOKEAN_MODEL, ConstitutiveModelParameters::NEOHOOKEAN_MODEL},
{"nHK", ConstitutiveModelParameters::NEOHOOKEAN_MODEL},
{ConstitutiveModelParameters::STVENANT_KIRCHHOFF_MODEL, ConstitutiveModelParameters::STVENANT_KIRCHHOFF_MODEL},
{"stVK", ConstitutiveModelParameters::STVENANT_KIRCHHOFF_MODEL},
}

Supported constitutive model types and their aliases.

◆ xml_element_name_

const std::string ConstitutiveModelParameters::xml_element_name_ = "Constitutive_model"
static

Process parameters for various constitutive models.

Define the XML element name for constitutive parameters.


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