MaterialLib::Solids Namespace Reference

Namespaces
	Creep
	Ehlers
	Lubby2
	MFront
	Phasefield

Classes
struct	MechanicsBase
class	LinearElasticIsotropic
class	LinearElasticOrthotropic

Enumerations
enum class	ConstitutiveModel {   Ehlers , LinearElasticIsotropic , Lubby2 , CreepBGRa ,   Invalid }

Functions
template<int DisplacementDim>
std::unique_ptr< MaterialLib::Solids::MechanicsBase< DisplacementDim > >	createConstitutiveRelation (std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &parameters, std::optional< ParameterLib::CoordinateSystem > const &local_coordinate_system, BaseLib::ConfigTree const &config)
template<int DisplacementDim>
std::map< int, std::unique_ptr< MaterialLib::Solids::MechanicsBase< DisplacementDim > > >	createConstitutiveRelations (std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &parameters, std::optional< ParameterLib::CoordinateSystem > const &local_coordinate_system, BaseLib::ConfigTree const &config)
template std::map< int, std::unique_ptr< MaterialLib::Solids::MechanicsBase< 2 > > >	createConstitutiveRelations< 2 > (std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &parameters, std::optional< ParameterLib::CoordinateSystem > const &local_coordinate_system, BaseLib::ConfigTree const &config)
template std::map< int, std::unique_ptr< MaterialLib::Solids::MechanicsBase< 3 > > >	createConstitutiveRelations< 3 > (std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &parameters, std::optional< ParameterLib::CoordinateSystem > const &local_coordinate_system, BaseLib::ConfigTree const &config)
template<int DisplacementDim>
std::unique_ptr< LinearElasticIsotropic< DisplacementDim > >	createLinearElasticIsotropic (std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &parameters, BaseLib::ConfigTree const &config, const bool skip_type_checking)
template<int DisplacementDim>
std::unique_ptr< LinearElasticOrthotropic< DisplacementDim > >	createLinearElasticOrthotropic (std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &parameters, std::optional< ParameterLib::CoordinateSystem > const &local_coordinate_system, BaseLib::ConfigTree const &config, const bool skip_type_checking)
template<int DisplacementDim>
MathLib::KelvinVector::KelvinMatrixType< DisplacementDim >	elasticTangentStiffness (double const first_lame_parameter, double const shear_modulus)
template<int DisplacementDim>
MechanicsBase< DisplacementDim > &	selectSolidConstitutiveRelation (std::map< int, std::unique_ptr< MechanicsBase< DisplacementDim >>> const &constitutive_relations, MeshLib::PropertyVector< int > const *const material_ids, std::size_t const element_id)

Enumeration Type Documentation

ConstitutiveModel

enum MaterialLib::Solids::ConstitutiveModel

strong

Enumerator
Ehlers
LinearElasticIsotropic
Lubby2
CreepBGRa
Invalid

Definition at line 37 of file MechanicsBase.h.

{
    Ehlers,
    LinearElasticIsotropic,
    Lubby2,
    CreepBGRa,
    Invalid
};

Function Documentation

createConstitutiveRelation()

template<int DisplacementDim>

std::unique_ptr<MaterialLib::Solids::MechanicsBase<DisplacementDim> > MaterialLib::Solids::createConstitutiveRelation	(	std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &	parameters,
		std::optional< ParameterLib::CoordinateSystem > const &	local_coordinate_system,
		BaseLib::ConfigTree const &	config
	)

Input File Parameter:

material__solid__constitutive_relation__type

Definition at line 34 of file CreateConstitutiveRelation.cpp.

{
    auto const type =
        config.peekConfigParameter<std::string>("type");
 
    if (type == "Ehlers")
    {
        return MaterialLib::Solids::Ehlers::createEhlers<DisplacementDim>(
            parameters, config);
    }
    if (type == "LinearElasticIsotropic")
    {
        const bool skip_type_checking = false;
        return MaterialLib::Solids::createLinearElasticIsotropic<
            DisplacementDim>(parameters, config, skip_type_checking);
    }
    if (type == "LinearElasticOrthotropic")
    {
        const bool skip_type_checking = false;
        return MaterialLib::Solids::createLinearElasticOrthotropic<
            DisplacementDim>(
            parameters, local_coordinate_system, config, skip_type_checking);
    }
    if (type == "Lubby2")
    {
        return MaterialLib::Solids::Lubby2::createLubby2<DisplacementDim>(
            parameters, config);
    }
    if (type == "CreepBGRa")
    {
        return MaterialLib::Solids::Creep::createCreepBGRa<DisplacementDim>(
            parameters, config);
    }
    if (type == "MFront")
    {
#ifdef OGS_USE_MFRONT
        return MaterialLib::Solids::MFront::createMFront<DisplacementDim>(
            parameters, local_coordinate_system, config);
#else   // OGS_USE_MFRONT
        OGS_FATAL(
            "OGS is compiled without MFront support. See OGS_USE_MFRONT CMake "
            "option.");
#endif  // OGS_USE_MFRONT
    }
    OGS_FATAL("Cannot construct constitutive relation of given type '{:s}'.",
              type);
}

References createLinearElasticIsotropic(), createLinearElasticOrthotropic(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

createConstitutiveRelations()

template<int DisplacementDim>

std::map< int, std::unique_ptr< MaterialLib::Solids::MechanicsBase< DisplacementDim > > > MaterialLib::Solids::createConstitutiveRelations	(	std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &	parameters,
		std::optional< ParameterLib::CoordinateSystem > const &	local_coordinate_system,
		BaseLib::ConfigTree const &	config
	)

Input File Parameter:

material__solid__constitutive_relation

Input File Parameter:

material__solid__constitutive_relation__id

Definition at line 90 of file CreateConstitutiveRelation.cpp.

{
    auto const constitutive_relation_configs =
        config.getConfigSubtreeList("constitutive_relation");
 
    std::map<int, std::unique_ptr<MechanicsBase<DisplacementDim>>>
        constitutive_relations;
 
    for (auto const& constitutive_relation_config :
         constitutive_relation_configs)
    {
        int const material_id =
            constitutive_relation_config.getConfigAttribute<int>("id", 0);
 
        if (constitutive_relations.find(material_id) !=
            constitutive_relations.end())
        {
            OGS_FATAL(
                "Multiple constitutive relations were specified for the same "
                "material id {:d}. Keep in mind, that if no material id is "
                "specified, it is assumed to be 0 by default.",
                material_id);
        }
 
        constitutive_relations.emplace(
            material_id,
            createConstitutiveRelation<DisplacementDim>(
                parameters,
                local_coordinate_system,
                constitutive_relation_config));
    }
 
    DBUG("Found {:d} constitutive relations.", constitutive_relations.size());
 
    return constitutive_relations;
}

References DBUG(), BaseLib::ConfigTree::getConfigSubtreeList(), and OGS_FATAL.

createConstitutiveRelations< 2 >()

template std::map< int, std::unique_ptr< MaterialLib::Solids::MechanicsBase< 2 > > > MaterialLib::Solids::createConstitutiveRelations< 2 >	(	std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &	parameters,
		std::optional< ParameterLib::CoordinateSystem > const &	local_coordinate_system,
		BaseLib::ConfigTree const &	config
	)

createConstitutiveRelations< 3 >()

template std::map< int, std::unique_ptr< MaterialLib::Solids::MechanicsBase< 3 > > > MaterialLib::Solids::createConstitutiveRelations< 3 >	(	std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &	parameters,
		std::optional< ParameterLib::CoordinateSystem > const &	local_coordinate_system,
		BaseLib::ConfigTree const &	config
	)

createLinearElasticIsotropic()

template<int DisplacementDim>

std::unique_ptr<LinearElasticIsotropic<DisplacementDim> > MaterialLib::Solids::createLinearElasticIsotropic	(	std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &	parameters,
		BaseLib::ConfigTree const &	config,
		const bool	skip_type_checking
	)

Input File Parameter:

material__solid__constitutive_relation__type

Input File Parameter:

material__solid__constitutive_relation__LinearElasticIsotropic__youngs_modulus

Input File Parameter:

material__solid__constitutive_relation__LinearElasticIsotropic__poissons_ratio

Definition at line 23 of file CreateLinearElasticIsotropic.h.

{
    if (!skip_type_checking)
    {
        config.checkConfigParameter("type", "LinearElasticIsotropic");
        DBUG("Create LinearElasticIsotropic material");
    }
 
    // Youngs modulus
    auto& youngs_modulus = ParameterLib::findParameter<double>(
        config, "youngs_modulus", parameters, 1);
 
    DBUG("Use '{:s}' as youngs_modulus parameter.", youngs_modulus.name);
 
    // Poissons ratio
    auto& poissons_ratio = ParameterLib::findParameter<double>(
        config, "poissons_ratio", parameters, 1);
 
    DBUG("Use '{:s}' as poissons_ratio parameter.", poissons_ratio.name);
 
    typename LinearElasticIsotropic<DisplacementDim>::MaterialProperties mp{
        youngs_modulus, poissons_ratio};
 
    return std::make_unique<LinearElasticIsotropic<DisplacementDim>>(mp);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), MaterialPropertyLib::poissons_ratio, and MaterialPropertyLib::youngs_modulus.

Referenced by createConstitutiveRelation().

createLinearElasticOrthotropic()

template<int DisplacementDim>

template std::unique_ptr< LinearElasticOrthotropic< 3 > > MaterialLib::Solids::createLinearElasticOrthotropic	(	std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &	parameters,
		std::optional< ParameterLib::CoordinateSystem > const &	local_coordinate_system,
		BaseLib::ConfigTree const &	config,
		const bool	skip_type_checking
	)

Input File Parameter:

material__solid__constitutive_relation__type

Input File Parameter:

material__solid__constitutive_relation__LinearElasticOrthotropic__youngs_moduli

Input File Parameter:

material__solid__constitutive_relation__LinearElasticOrthotropic__shear_moduli

Input File Parameter:

material__solid__constitutive_relation__LinearElasticOrthotropic__poissons_ratios

Definition at line 20 of file CreateLinearElasticOrthotropic.cpp.

{
    if (!skip_type_checking)
    {
        config.checkConfigParameter("type", "LinearElasticOrthotropic");
        DBUG("Create LinearElasticOrthotropic material");
    }
 
    // The three Youngs moduli are required even in two-dimensional case. Same
    // for the shear moduli and the Poissons ratios.
    auto& youngs_moduli = ParameterLib::findParameter<double>(
        config, "youngs_moduli", parameters, 3);
    DBUG("Use '{:s}' as youngs_moduli parameter.", youngs_moduli.name);
 
    // Shear moduli
    auto& shear_moduli = ParameterLib::findParameter<double>(
        config, "shear_moduli", parameters, 3);
    DBUG("Use '{:s}' as shear_moduli parameter.", shear_moduli.name);
 
    // Poissons ratios
    auto& poissons_ratios = ParameterLib::findParameter<double>(
        config, "poissons_ratios", parameters, 3);
    DBUG("Use '{:s}' as poissons_ratios parameter.", poissons_ratios.name);
 
    typename LinearElasticOrthotropic<DisplacementDim>::MaterialProperties mp{
        youngs_moduli, shear_moduli, poissons_ratios};
 
    return std::make_unique<LinearElasticOrthotropic<DisplacementDim>>(
        mp, local_coordinate_system);
}

References BaseLib::ConfigTree::checkConfigParameter(), and DBUG().

Referenced by createConstitutiveRelation().

elasticTangentStiffness()

template<int DisplacementDim>

MathLib::KelvinVector::KelvinMatrixType<DisplacementDim> MaterialLib::Solids::elasticTangentStiffness	(	double const	first_lame_parameter,
		double const	shear_modulus
	)

Definition at line 125 of file LinearElasticIsotropic.h.

{
    using KelvinMatrix =
        MathLib::KelvinVector::KelvinMatrixType<DisplacementDim>;
 
    KelvinMatrix tangentStiffness = KelvinMatrix::Zero();
    tangentStiffness.template topLeftCorner<3, 3>().setConstant(
        first_lame_parameter);
    tangentStiffness.noalias() += 2 * shear_modulus * KelvinMatrix::Identity();
    return tangentStiffness;
}

selectSolidConstitutiveRelation()

template<int DisplacementDim>

MechanicsBase<DisplacementDim>& MaterialLib::Solids::selectSolidConstitutiveRelation	(	std::map< int, std::unique_ptr< MechanicsBase< DisplacementDim >>> const &	constitutive_relations,
		MeshLib::PropertyVector< int > const *const	material_ids,
		std::size_t const	element_id
	)

Choose solid material model for given element id out of a set of models, possibly using the material ids.

Only two possibilities yield a valid result and result in OGS_FATAL call otherwise.

1. There is only one constitutive relation in the set of constitutive_relations, then the material and element ids are ignored and the only constitutive relation (under id 0) is returned.
2. For each material id chosen for the given element id there exists a constitutive relation in the set.

Definition at line 33 of file SelectSolidConstitutiveRelation.h.

{
    int material_id;
    if (constitutive_relations.size() == 1 || material_ids == nullptr)
    {
        material_id = 0;
    }
    else
    {
        material_id = (*material_ids)[element_id];
    }
 
    auto const constitutive_relation = constitutive_relations.find(material_id);
    if (constitutive_relation == end(constitutive_relations))
    {
        OGS_FATAL(
            "No constitutive relation found for material id {:d} and element "
            "{:d}. There are {:d} constitutive relations available.",
            material_id, element_id, constitutive_relations.size());
    }
 
    if (constitutive_relation->second == nullptr)
    {
        OGS_FATAL(
            "The constitutive relation found for material id {:d} and element "
            "{:d} is a nullptr, which is impossible.",
            material_id, element_id);
    }
 
    return *constitutive_relation->second;
}

References OGS_FATAL.

Referenced by ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, IntegrationMethod, DisplacementDim >::HydroMechanicsLocalAssembler(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerMatrix< ShapeFunctionDisplacement, ShapeFunctionPressure, IntegrationMethod, GlobalDim >::HydroMechanicsLocalAssemblerMatrix(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, IntegrationMethod, DisplacementDim >::PhaseFieldLocalAssembler(), ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, IntegrationMethod, DisplacementDim >::RichardsMechanicsLocalAssembler(), ProcessLib::SmallDeformation::SmallDeformationLocalAssembler< ShapeFunction, IntegrationMethod, DisplacementDim >::SmallDeformationLocalAssembler(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerMatrix< ShapeFunction, IntegrationMethod, DisplacementDim >::SmallDeformationLocalAssemblerMatrix(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerMatrixNearFracture< ShapeFunction, IntegrationMethod, DisplacementDim >::SmallDeformationLocalAssemblerMatrixNearFracture(), ProcessLib::SmallDeformationNonlocal::SmallDeformationNonlocalLocalAssembler< ShapeFunction, IntegrationMethod, DisplacementDim >::SmallDeformationNonlocalLocalAssembler(), ProcessLib::TH2M::TH2MLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, IntegrationMethod, DisplacementDim >::TH2MLocalAssembler(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, IntegrationMethod, DisplacementDim >::ThermoHydroMechanicsLocalAssembler(), ProcessLib::ThermoMechanicalPhaseField::ThermoMechanicalPhaseFieldLocalAssembler< ShapeFunction, IntegrationMethod, DisplacementDim >::ThermoMechanicalPhaseFieldLocalAssembler(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, IntegrationMethod, DisplacementDim >::ThermoMechanicsLocalAssembler(), and ProcessLib::ThermoRichardsMechanics::ThermoRichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunction, IntegrationMethod, DisplacementDim >::ThermoRichardsMechanicsLocalAssembler().