Structure to read and store material related data. More...

#include <materialDeck.h>

Collaboration diagram for inp::MaterialDeck:

Public Member Functions
	MaterialDeck (const json &j=json({}))
	Constructor.

	MaterialDeck (std::string materialType, bool isPlainStrain=false, double horizon=-1., double horizonMeshRatio=-1., double density=1., double K=0., double G=0., double Gc=0., bool computeParamsFromElastic=true, size_t influenceFnType=0)
	Constructor.

	MaterialDeck (const MaterialDeck &md)
	Copy constructor.

void	readFromJson (const json &j)
	Reads from json object.

std::string	printStr (int nt=0, int lvl=0) const
	Returns the string containing printable information about the object.

void	print (int nt=0, int lvl=0) const
	Prints the information about the object.

Static Public Member Functions
static const std::vector< Field< MaterialDeck > > &	fields ()
	The fields of the block itself.

static const std::vector< Field< MaterialDeck > > &	influenceFields ()
	The fields of the Influence_Function sub-block.

static const std::vector< OneOf > &	groups ()
	Quantities this deck accepts in more than one form.

static json	getExampleJson (const json &given=json::object())
	Returns example JSON object for ModelDeck configuration.

static json	getExampleJson (const std::string &)=delete
	Rejects a value given where a set of named values is expected.

static json	getExampleJson (const char *)=delete
	Rejects a value given where a set of named values is expected.

Data Fields
bool	d_isPlaneStrain
	Indicates if the 2-d simulation is of plane-strain type (thick material) or plane-stress type (thin material)

std::string	d_materialType
	Material type.

size_t	d_bondPotentialType
	Type of pairwise (bond-based) potential.

size_t	d_statePotentialType
	Type of hydrostatic (state-based) potential.

size_t	d_influenceFnType
	Type of influence function.

std::vector< double >	d_bondPotentialParams
	List of parameters for pairwise potential.

std::vector< double >	d_statePotentialParams
	List of parameters for hydrostatic potential.

std::vector< double >	d_influenceFnParams
	List of parameters for influence function.

bool	d_irreversibleBondBreak
	Flag for irreversible breaking of bonds.

bool	d_stateContributionFromBrokenBond
	Flag for contribution to hydrostatic force from the broken bond.

double	d_checkScFactor
	Factor to check if bond is broken.

bool	d_computeParamsFromElastic
	Compute Peridynamic material properties from elastic properties.

inp::MatData	d_matData
	List of elastic and fracture properties.

double	d_density
	Density of material.

double	d_horizon
	Horizon for peridynamic interaction.

double	d_horizonMeshRatio
	Horizon to mesh ratio.

Detailed Description

Structure to read and store material related data.

Definition at line 270 of file materialDeck.h.

Constructor & Destructor Documentation

◆ MaterialDeck() [1/3]

inp::MaterialDeck::MaterialDeck ( const json & j = json({}) )

inline

Constructor.

Definition at line 330 of file materialDeck.h.

                                    {}))
      : d_materialType(""),
        d_isPlaneStrain(false), d_bondPotentialType(0), d_statePotentialType(0),
        d_influenceFnType(0), d_irreversibleBondBreak(true),
        d_stateContributionFromBrokenBond(true), d_checkScFactor(1.),
        d_computeParamsFromElastic(true), d_matData(inp::MatData()),
        d_density(1.), d_horizon(-1.), d_horizonMeshRatio(-1.) {
    readFromJson(j);
  };

◆ MaterialDeck() [2/3]

inp::MaterialDeck::MaterialDeck	(	std::string	materialType,
		bool	isPlainStrain = `false`,
		double	horizon = `-1.`,
		double	horizonMeshRatio = `-1.`,
		double	density = `1.`,
		double	K = `0.`,
		double	G = `0.`,
		double	Gc = `0.`,
		bool	computeParamsFromElastic = `true`,
		size_t	influenceFnType = `0`
	)

inline

Constructor.

Definition at line 343 of file materialDeck.h.

      : d_materialType(materialType),
        d_isPlaneStrain(isPlainStrain), d_bondPotentialType(0), d_statePotentialType(0),
        d_influenceFnType(influenceFnType), d_irreversibleBondBreak(true),
        d_stateContributionFromBrokenBond(true), d_checkScFactor(1.),
        d_computeParamsFromElastic(computeParamsFromElastic), d_matData(inp::MatData()),
        d_density(density), d_horizon(horizon), d_horizonMeshRatio(horizonMeshRatio) {
 
    d_matData.d_K = K;
    d_matData.d_G = G;
    d_matData.d_Gc = Gc;
  };

References inp::MatData::d_G, inp::MatData::d_Gc, inp::MatData::d_K, and d_matData.

◆ MaterialDeck() [3/3]

inp::MaterialDeck::MaterialDeck ( const MaterialDeck & md )

inline

Copy constructor.

Parameters

md	Another MaterialDeck object

Definition at line 364 of file materialDeck.h.

      : d_materialType(md.d_materialType),
        d_isPlaneStrain(md.d_isPlaneStrain),
        d_bondPotentialType(md.d_bondPotentialType),
        d_statePotentialType(md.d_statePotentialType),
        d_influenceFnType(md.d_influenceFnType),
        d_bondPotentialParams(md.d_bondPotentialParams),
        d_statePotentialParams(md.d_statePotentialParams),
        d_influenceFnParams(md.d_influenceFnParams),
        d_irreversibleBondBreak(md.d_irreversibleBondBreak),
        d_stateContributionFromBrokenBond(md.d_stateContributionFromBrokenBond),
        d_checkScFactor(md.d_checkScFactor),
        d_computeParamsFromElastic(md.d_computeParamsFromElastic),
        d_matData(md.d_matData), d_density(md.d_density),
        d_horizon(md.d_horizon), d_horizonMeshRatio(md.d_horizonMeshRatio){};

Member Function Documentation

◆ fields()

static const std::vector< Field< MaterialDeck > > & inp::MaterialDeck::fields ( )

inlinestatic

The fields of the block itself.

A horizon or a ratio that is not given keeps -1 and is left out of the block, which is how the material classes read it as absent.

Returns: fields The field table

Definition at line 388 of file materialDeck.h.

                                                        {
    static const std::vector<Field<MaterialDeck>> f = {
        field(&MaterialDeck::d_materialType, "Type", std::string(),
              "Peridynamic material model"),
        field(&MaterialDeck::d_density, "Density", 1., "Mass density"),
        field(&MaterialDeck::d_computeParamsFromElastic,
              "Compute_From_Classical", true,
              "Derive the bond parameters from the elastic constants"),
        field<MaterialDeck, bool>(&MaterialDeck::d_isPlaneStrain,
                                  "Is_Plane_Strain", false,
                                  "Plane strain rather than plane stress", {},
                                  [](const bool &v) { return v; }),
        field<MaterialDeck, double>(&MaterialDeck::d_horizon, "Horizon", -1.,
                                    "Peridynamic horizon", {},
                                    [](const double &v) { return v > 0.; }),
        field<MaterialDeck, double>(&MaterialDeck::d_horizonMeshRatio,
                                    "Horizon_Mesh_Ratio", -1.,
                                    "Horizon as a multiple of the mesh size",
                                    {},
                                    [](const double &v) { return v > 0.; }),
        field<MaterialDeck, std::vector<double>>(
            &MaterialDeck::d_bondPotentialParams, "Bond_Potential_Params", {},
            "Bond parameters given directly rather than derived", {},
            [](const std::vector<double> &v) { return !v.empty(); }),
        field<MaterialDeck, std::vector<double>>(
            &MaterialDeck::d_statePotentialParams, "State_Potential_Params",
            {}, "State parameters given directly rather than derived", {},
            [](const std::vector<double> &v) { return !v.empty(); }),
    };
    return f;
  }

References d_bondPotentialParams, d_computeParamsFromElastic, d_density, d_horizon, d_horizonMeshRatio, d_isPlaneStrain, d_materialType, d_statePotentialParams, and inp::field().

Referenced by getExampleJson(), and readFromJson().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExampleJson() [1/3]

static json inp::MaterialDeck::getExampleJson ( const char * )

staticdelete

Rejects a value given where a set of named values is expected.

A material type passed on its own would convert to a JSON string and be read as a block with no keys, so such a call is rejected when compiling.

◆ getExampleJson() [2/3]

static json inp::MaterialDeck::getExampleJson ( const json & given = json::object() )

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns: JSON object with example configuration

Returns the block with the given fields set

The extent of a bond is given either as Horizon, a length, or as Horizon_Mesh_Ratio, a multiple of the mesh size; naming one of the two is what selects it. The elastic constants K, G and Gc are written as given, since a material that states none of them cannot be built, and E is derived from K when it is not named.

Parameters

given Field names and values to set, checked against the table

Returns: JSON object for this deck

Definition at line 463 of file materialDeck.h.

                                                               {
    const std::vector<std::string> extra = {"E", "K", "G", "Gc",
                                            "Influence_Function"};
    json j = applyGiven(given, fields(), extra);
    checkGroups(j, groups());
    return j;
  }

References inp::applyGiven(), inp::checkGroups(), fields(), and groups().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExampleJson() [3/3]

static json inp::MaterialDeck::getExampleJson ( const std::string & )

staticdelete

Rejects a value given where a set of named values is expected.

A material type passed on its own would convert to a JSON string and be read as a block with no keys, so such a call is rejected when compiling.

◆ groups()

static const std::vector< OneOf > & inp::MaterialDeck::groups ( )

inlinestatic

Quantities this deck accepts in more than one form.

Returns: groups The groups

Definition at line 440 of file materialDeck.h.

                                          {
    static const std::vector<OneOf> g = {
        {"the horizon", {"Horizon", "Horizon_Mesh_Ratio"}},
    };
    return g;
  }

Referenced by getExampleJson(), and readFromJson().

Here is the caller graph for this function:

◆ influenceFields()

static const std::vector< Field< MaterialDeck > > & inp::MaterialDeck::influenceFields ( )

inlinestatic

The fields of the Influence_Function sub-block.

Returns: fields The field table

Definition at line 424 of file materialDeck.h.

                                                                 {
    static const std::vector<Field<MaterialDeck>> f = {
        field(&MaterialDeck::d_influenceFnType, "Type", size_t(0),
              "Influence function used in the bond force"),
        field<MaterialDeck, std::vector<double>>(
            &MaterialDeck::d_influenceFnParams, "Parameters", {},
            "Parameters of the influence function", {},
            [](const std::vector<double> &v) { return !v.empty(); }),
    };
    return f;
  }

References d_influenceFnParams, d_influenceFnType, and inp::field().

Referenced by readFromJson().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print()

void inp::MaterialDeck::print	(	int	nt = `0`,
		int	lvl = `0`
	)		const

inline

Prints the information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Definition at line 560 of file materialDeck.h.

560{ std::cout << printStr(nt, lvl); }

inp::MaterialDeck::printStr

std::string printStr(int nt=0, int lvl=0) const

Returns the string containing printable information about the object.

Definition materialDeck.h:515

References printStr().

Here is the call graph for this function:

◆ printStr()

std::string inp::MaterialDeck::printStr	(	int	nt = `0`,
		int	lvl = `0`
	)		const

inline

Returns the string containing printable information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Returns: string String containing printable information about the object

Definition at line 515 of file materialDeck.h.

                                                    {
 
    auto tabS = util::io::getTabS(nt);
    std::ostringstream oss;
    oss << tabS << "------- MaterialDeck --------" << std::endl << std::endl;
    oss << tabS << "Is plain strain = " << d_isPlaneStrain << std::endl;
    oss << tabS << "Material type = " << d_materialType << std::endl;
    oss << tabS << "Bond potential type = " << d_bondPotentialType << std::endl;
    oss << tabS << "Bond potential params = ["
        << util::io::printStr<double>(d_bondPotentialParams, 0) << "]"
        << std::endl;
    oss << tabS << "State potential type = " << d_statePotentialType
        << std::endl;
    oss << tabS << "State potential params = ["
        << util::io::printStr<double>(d_statePotentialParams, 0) << "]"
        << std::endl;
    oss << tabS << "Influence function type = " << d_influenceFnType
        << std::endl;
    oss << tabS << "Influence function params = ["
        << util::io::printStr<double>(d_influenceFnParams, 0) << "]"
        << std::endl;
    oss << tabS
        << "Irreversible bond breaking enabled = " << d_irreversibleBondBreak
        << std::endl;
    oss << tabS << "State contribution from broken bond enabled = "
        << d_stateContributionFromBrokenBond << std::endl;
    oss << tabS << "Check Sc factor = " << d_checkScFactor << std::endl;
    oss << tabS << "Compute parameters from elastic properties = "
        << d_computeParamsFromElastic << std::endl;
    oss << d_matData.printStr(nt + 1, lvl);
    oss << tabS << "Density = " << d_density << std::endl;
    oss << tabS << "Horizon = " << d_horizon << std::endl;
    oss << tabS << "Horizon to mesh ratio = " << d_horizonMeshRatio
        << std::endl;
    oss << tabS << std::endl;
 
    return oss.str();
  }

References d_bondPotentialParams, d_bondPotentialType, d_checkScFactor, d_computeParamsFromElastic, d_density, d_horizon, d_horizonMeshRatio, d_influenceFnParams, d_influenceFnType, d_irreversibleBondBreak, d_isPlaneStrain, d_matData, d_materialType, d_stateContributionFromBrokenBond, d_statePotentialParams, d_statePotentialType, util::io::getTabS(), and inp::MatData::printStr().

Referenced by material::PdState::computeParameters(), and print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFromJson()

void inp::MaterialDeck::readFromJson ( const json & j )

inline

Reads from json object.

Definition at line 484 of file materialDeck.h.

                                   {
    if (j.empty())
      return;
 
    // read mat data
    d_matData.readFromJson(j);
 
    readFields(*this, j, fields());
 
    // Older decks spell this Is_Plain_Strain. The table reads the current
    // spelling, so the older one is applied when it alone is present.
    if (j.find("Is_Plane_Strain") == j.end() &&
        j.find("Is_Plain_Strain") != j.end())
      d_isPlaneStrain = j.at("Is_Plain_Strain").get<bool>();
 
    checkGroups(j, groups());
 
    if (j.find("Influence_Function") != j.end())
      readFields(*this, j.at("Influence_Function"), influenceFields());
    if (!d_computeParamsFromElastic && d_bondPotentialParams.empty())
      throw std::runtime_error(
          "Compute_From_Classical is false but Bond_Potential_Params is missing.");
  }

References inp::checkGroups(), d_bondPotentialParams, d_computeParamsFromElastic, d_isPlaneStrain, d_matData, fields(), groups(), influenceFields(), inp::readFields(), and inp::MatData::readFromJson().

Referenced by anonymous_namespace{testDeckRoundTrip.cpp}::testMaterialDeck().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ d_bondPotentialParams

std::vector<double> inp::MaterialDeck::d_bondPotentialParams

List of parameters for pairwise potential.

Definition at line 291 of file materialDeck.h.

Referenced by fields(), material::PdElastic::PdElastic(), material::PdState::PdState(), material::PmbMaterial::PmbMaterial(), printStr(), readFromJson(), and material::RnpMaterial::RnpMaterial().

◆ d_bondPotentialType

size_t inp::MaterialDeck::d_bondPotentialType

Type of pairwise (bond-based) potential.

Definition at line 282 of file materialDeck.h.

Referenced by printStr().

◆ d_checkScFactor

double inp::MaterialDeck::d_checkScFactor

Factor to check if bond is broken.

Definition at line 310 of file materialDeck.h.

Referenced by printStr().

◆ d_computeParamsFromElastic

bool inp::MaterialDeck::d_computeParamsFromElastic

Compute Peridynamic material properties from elastic properties.

Definition at line 313 of file materialDeck.h.

Referenced by fields(), material::PdElastic::PdElastic(), material::PdState::PdState(), material::PmbMaterial::PmbMaterial(), printStr(), readFromJson(), and material::RnpMaterial::RnpMaterial().

◆ d_density

double inp::MaterialDeck::d_density

Density of material.

Definition at line 319 of file materialDeck.h.

Referenced by fields(), and printStr().

◆ d_horizon

double inp::MaterialDeck::d_horizon

Horizon for peridynamic interaction.

Definition at line 322 of file materialDeck.h.

Referenced by particle::BaseParticle::BaseParticle(), fields(), and printStr().

◆ d_horizonMeshRatio

double inp::MaterialDeck::d_horizonMeshRatio

Horizon to mesh ratio.

Definition at line 325 of file materialDeck.h.

Referenced by particle::BaseParticle::BaseParticle(), fields(), and printStr().

◆ d_influenceFnParams

std::vector<double> inp::MaterialDeck::d_influenceFnParams

List of parameters for influence function.

Definition at line 297 of file materialDeck.h.

Referenced by material::PmbMaterial::computeParameters(), material::PdElastic::computeParameters(), influenceFields(), material::PdElastic::PdElastic(), material::PdState::PdState(), material::PmbMaterial::PmbMaterial(), printStr(), and material::RnpMaterial::RnpMaterial().

◆ d_influenceFnType

size_t inp::MaterialDeck::d_influenceFnType

Type of influence function.

Definition at line 288 of file materialDeck.h.

Referenced by material::PmbMaterial::computeParameters(), material::PdElastic::computeParameters(), material::PdState::computeParameters(), influenceFields(), material::PdElastic::PdElastic(), material::PdState::PdState(), material::PmbMaterial::PmbMaterial(), printStr(), and material::RnpMaterial::RnpMaterial().

◆ d_irreversibleBondBreak

bool inp::MaterialDeck::d_irreversibleBondBreak

Flag for irreversible breaking of bonds.

True means bond breaking is irreversible.

Definition at line 304 of file materialDeck.h.

Referenced by printStr().

◆ d_isPlaneStrain

bool inp::MaterialDeck::d_isPlaneStrain

Indicates if the 2-d simulation is of plane-strain type (thick material) or plane-stress type (thin material)

Definition at line 276 of file materialDeck.h.

Referenced by fields(), material::PdElastic::PdElastic(), material::PdState::PdState(), material::PmbMaterial::PmbMaterial(), printStr(), readFromJson(), and material::RnpMaterial::RnpMaterial().

◆ d_matData

inp::MatData inp::MaterialDeck::d_matData

List of elastic and fracture properties.

Definition at line 316 of file materialDeck.h.

Referenced by material::RnpMaterial::computeParameters(), material::PmbMaterial::computeParameters(), material::PdElastic::computeParameters(), material::PdState::computeParameters(), MaterialDeck(), printStr(), and readFromJson().

◆ d_materialType

std::string inp::MaterialDeck::d_materialType

Material type.

Definition at line 279 of file materialDeck.h.

Referenced by particle::BaseParticle::BaseParticle(), fields(), and printStr().

◆ d_stateContributionFromBrokenBond

bool inp::MaterialDeck::d_stateContributionFromBrokenBond

Flag for contribution to hydrostatic force from the broken bond.

Definition at line 307 of file materialDeck.h.

Referenced by printStr().

◆ d_statePotentialParams

std::vector<double> inp::MaterialDeck::d_statePotentialParams

List of parameters for hydrostatic potential.

Definition at line 294 of file materialDeck.h.

Referenced by fields(), and printStr().

◆ d_statePotentialType

size_t inp::MaterialDeck::d_statePotentialType

Type of hydrostatic (state-based) potential.

Definition at line 285 of file materialDeck.h.

Referenced by printStr().

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

/home/user/project/src/inp/materialDeck.h

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ MaterialDeck() [1/3]

◆ MaterialDeck() [2/3]

◆ MaterialDeck() [3/3]

Member Function Documentation

◆ fields()

◆ getExampleJson() [1/3]

◆ getExampleJson() [2/3]

◆ getExampleJson() [3/3]

◆ groups()

◆ influenceFields()

◆ print()

◆ printStr()

◆ readFromJson()

Field Documentation

◆ d_bondPotentialParams

◆ d_bondPotentialType

◆ d_checkScFactor

◆ d_computeParamsFromElastic

◆ d_density

◆ d_horizon

◆ d_horizonMeshRatio

◆ d_influenceFnParams

◆ d_influenceFnType

◆ d_irreversibleBondBreak

◆ d_isPlaneStrain

◆ d_matData

◆ d_materialType

◆ d_stateContributionFromBrokenBond

◆ d_statePotentialParams

◆ d_statePotentialType