Class the stores and manages user-defined constants.
More...
#include <user_constants.h>
|
|
using | InputVariant = boost::variant< double, int, bool, dealii::Tensor< 1, dim >, dealii::Tensor< 2, dim >, dealii::Tensor< 2,(2 *dim) - 1+(dim/3)> > |
| |
|
|
InputVariant | construct_user_constant (std::vector< std::string > &model_constants_strings) |
| | Assign the specified user constant to whatever type.
|
| |
| double | get_model_constant_double (const std::string &constant_name) const |
| | Retrieve the double from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
|
| |
| int | get_model_constant_int (const std::string &constant_name) const |
| | Retrieve the int from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
|
| |
| bool | get_model_constant_bool (const std::string &constant_name) const |
| | Retrieve the bool from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
|
| |
| dealii::Tensor< 1, dim > | get_model_constant_rank_1_tensor (const std::string &constant_name) const |
| | Retrieve the rank 1 tensor from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
|
| |
| dealii::Tensor< 2, dim > | get_model_constant_rank_2_tensor (const std::string &constant_name) const |
| | Retrieve the rank 2 tensor from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
|
| |
| dealii::Tensor< 2,(2 *dim) - 1+(dim/3)> | get_model_constant_elasticity_tensor (const std::string &constant_name) const |
| | Retrieve the elasticity tensor from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
|
| |
|
|
std::map< std::string, InputVariant > | model_constants |
| |
template<int dim>
class userConstants< dim >
Class the stores and manages user-defined constants.
◆ get_model_constant_bool()
template<int dim>
| bool userConstants< dim >::get_model_constant_bool |
( |
const std::string & |
constant_name | ) |
const |
|
inline |
Retrieve the bool from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
- Parameters
-
| constant_name | Name of the constant to retrieve. |
◆ get_model_constant_double()
template<int dim>
| double userConstants< dim >::get_model_constant_double |
( |
const std::string & |
constant_name | ) |
const |
|
inline |
Retrieve the double from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
- Parameters
-
| constant_name | Name of the constant to retrieve. |
◆ get_model_constant_elasticity_tensor()
template<int dim>
| dealii::Tensor< 2,(2 *dim) - 1+(dim/3)> userConstants< dim >::get_model_constant_elasticity_tensor |
( |
const std::string & |
constant_name | ) |
const |
|
inline |
Retrieve the elasticity tensor from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
- Parameters
-
| constant_name | Name of the constant to retrieve. |
◆ get_model_constant_int()
template<int dim>
| int userConstants< dim >::get_model_constant_int |
( |
const std::string & |
constant_name | ) |
const |
|
inline |
Retrieve the int from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
- Parameters
-
| constant_name | Name of the constant to retrieve. |
◆ get_model_constant_rank_1_tensor()
template<int dim>
| dealii::Tensor< 1, dim > userConstants< dim >::get_model_constant_rank_1_tensor |
( |
const std::string & |
constant_name | ) |
const |
|
inline |
Retrieve the rank 1 tensor from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
- Parameters
-
| constant_name | Name of the constant to retrieve. |
◆ get_model_constant_rank_2_tensor()
template<int dim>
| dealii::Tensor< 2, dim > userConstants< dim >::get_model_constant_rank_2_tensor |
( |
const std::string & |
constant_name | ) |
const |
|
inline |
Retrieve the rank 2 tensor from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.
- Parameters
-
| constant_name | Name of the constant to retrieve. |
The documentation for this class was generated from the following file:
- /home/runner/work/phaseField/phaseField/include/prismspf/user_inputs/user_constants.h
1.9.8 