Structure to read and store model related input data. More...

#include <modelDeck.h>

Collaboration diagram for inp::ModelDeck:

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

	ModelDeck (size_t dim, double tFinal=1.0, size_t Nt=10, std::string spatialDiscretization="finite_difference", std::string timeDiscretization="central_difference", bool populateElementNodeConnectivity=true, size_t quadOrder=2, std::string particleSimType="Multi_Particle", int seed=0)

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< ModelDeck > > &	fields ()
	Returns example JSON object for ModelDeck configuration.

static json	getExampleJson (const json &given=json::object())
	Returns the block with the given fields set.

Data Fields
std::string	d_simType
	Simulation type.

bool	d_isRestartActive
	Flag indicating if this restart problem.

std::string	d_spatialDiscretization
	Tag for spatial discretization.

std::string	d_timeDiscretization
	Tag for time discretization.

bool	d_populateElementNodeConnectivity
	Flag to indicate if we should populate element-node connectivity data in meshes.

size_t	d_quadOrder
	Order of quadrature approximation for strain and stress computation (default is 1)

std::string	d_particleSimType
	Specify if this is single or multi particle simulation Expected value is either 'Single_Particle' or 'Multi_Particle'.

std::string	d_mpiStrategy
	MPI domain-decomposition strategy (independent of Particle_Sim_Type).

std::string	d_bondBreak
	Bond failure criterion: `tension` (default) or `absolute_stretch`.

std::vector< std::pair< size_t, double > >	d_rigidParticles
	Rigid translating particles: `{"Id": <id>, "Mass": <mass>}`. Nodal force densities are set to density * (net force / Mass).

std::string	d_selfContact
	Intra-body self-contact law name (default `broken_bond_kn`).

std::string	d_wallContact
	Wall contact representation: `meshed` (default) or `analytical_plane`.

size_t	d_dim
	Dimension.

double	d_tFinal
	Final simulation time.

double	d_dt
	Size of time steps.

size_t	d_Nt
	Number of time steps.

int	d_seed
	Seed for random calculations (if any)

Detailed Description

Structure to read and store model related input data.

Definition at line 27 of file modelDeck.h.

Constructor & Destructor Documentation

◆ ModelDeck() [1/2]

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

inline

Constructor.

Definition at line 125 of file modelDeck.h.

                                   {}))
        : d_dim(0), d_isRestartActive(false), d_populateElementNodeConnectivity(false),
          d_tFinal(0.), d_dt(0.), d_Nt(0),
          d_particleSimType(""), d_mpiStrategy("auto"),
          d_bondBreak("tension"), d_selfContact("broken_bond_kn"),
          d_wallContact("meshed"), d_seed(0), d_quadOrder(1) {
 
      readFromJson(j);
    };

◆ ModelDeck() [2/2]

inp::ModelDeck::ModelDeck	(	size_t	dim,
		double	tFinal = `1.0`,
		size_t	Nt = `10`,
		std::string	spatialDiscretization = `"finite_difference"`,
		std::string	timeDiscretization = `"central_difference"`,
		bool	populateElementNodeConnectivity = `true`,
		size_t	quadOrder = `2`,
		std::string	particleSimType = `"Multi_Particle"`,
		int	seed = `0`
	)

inline

Definition at line 135 of file modelDeck.h.

        : d_dim(dim), d_isRestartActive(false),
          d_spatialDiscretization(spatialDiscretization),
          d_timeDiscretization(timeDiscretization),
          d_populateElementNodeConnectivity(populateElementNodeConnectivity),
          d_tFinal(tFinal), d_dt(0.), d_Nt(Nt),
          d_particleSimType(particleSimType), d_mpiStrategy("auto"),
          d_bondBreak("tension"), d_selfContact("broken_bond_kn"),
          d_wallContact("meshed"), d_seed(seed), d_quadOrder(quadOrder) {
 
      if (d_timeDiscretization == "central_difference" or d_timeDiscretization == "velocity_verlet")
        d_simType = "explicit";
 
      if (std::abs(d_tFinal) < 1.0E-10 or d_Nt <= 0) {
        throw std::runtime_error(
            util::io::Msg()
            << "Error: Check Final_Time and Time_Steps data.\n");
      }
 
      d_dt = d_tFinal / d_Nt;
    };

References d_dt, d_Nt, d_simType, d_tFinal, and d_timeDiscretization.

Member Function Documentation

◆ fields()

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

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns: JSON object with example configuration

The fields of this deck, declared once

Reading, writing, printing and the schema are generated from this table. The discretization block, the simulation type it implies, the time step and the rigid particles are read in readDerived.

Returns: fields The field table

Definition at line 177 of file modelDeck.h.

                                                       {
      static const std::vector<Field<ModelDeck>> f = {
          field(&ModelDeck::d_dim, "Dimension", size_t(2),
                "Spatial dimension", {{size_t(1), size_t(2), size_t(3)}, {}, {}}),
          field(&ModelDeck::d_tFinal, "Final_Time", 1.0,
                "End of the integration window"),
          field(&ModelDeck::d_Nt, "Time_Steps", size_t(10),
                "Number of time steps", {{}, size_t(1), {}}),
          field(&ModelDeck::d_populateElementNodeConnectivity,
                "Populate_ElementNodeConnectivity", true,
                "Build the element to node map, which strain output needs"),
          field(&ModelDeck::d_quadOrder, "Quad_Approximation_Order", size_t(2),
                "Order of the quadrature rule"),
          field(&ModelDeck::d_particleSimType, "Particle_Sim_Type",
                std::string("Multi_Particle"), "One body or many",
                {{"Multi_Particle", "Single_Particle"}, {}, {}}),
          field(&ModelDeck::d_mpiStrategy, "MPI_Strategy", std::string("auto"),
                "What is distributed across ranks",
                {{"auto", "none", "particle", "dof"}, {}, {}}),
          field(&ModelDeck::d_bondBreak, "Bond_Break", std::string("tension"),
                "Criterion for breaking a bond",
                {{"tension", "absolute_stretch"}, {}, {}}),
          field(&ModelDeck::d_selfContact, "Self_Contact",
                std::string("broken_bond_kn"),
                "Contact across broken bonds inside one body",
                {{"broken_bond_kn", "reference_gap", "none"}, {}, {}}),
          field(&ModelDeck::d_wallContact, "Wall_Contact",
                std::string("meshed"), "How a wall is represented for contact",
                {{"meshed", "analytical_plane"}, {}, {}}),
          field(&ModelDeck::d_seed, "Seed", 0,
                "Seed of the random number generator"),
      };
      return f;
    }

References d_bondBreak, d_dim, d_mpiStrategy, d_Nt, d_particleSimType, d_populateElementNodeConnectivity, d_quadOrder, d_seed, d_selfContact, d_tFinal, d_wallContact, and inp::field().

Referenced by getExampleJson(), printStr(), and readFromJson().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExampleJson()

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

inlinestatic

Returns the block with the given fields set.

Parameters

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

Returns: JSON object for this deck

Definition at line 217 of file modelDeck.h.

                                                                 {
      json j = applyGiven(given, fields(),
                          {"Discretization_Type", "Rigid_Particles"});
      if (j.find("Discretization_Type") == j.end())
        j["Discretization_Type"] = json{{"Spatial", "finite_difference"},
                                        {"Time", "central_difference"}};
      return j;
    }

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print()

void inp::ModelDeck::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 293 of file modelDeck.h.

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

inp::ModelDeck::printStr

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

Returns the string containing printable information about the object.

Definition modelDeck.h:270

References printStr().

Here is the call graph for this function:

◆ printStr()

std::string inp::ModelDeck::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 270 of file modelDeck.h.

                                                      {
      auto tabS = util::io::getTabS(nt);
      std::ostringstream oss;
      oss << tabS << "------- ModelDeck --------" << std::endl << std::endl;
      printFields(*this, oss, fields(), tabS);
      oss << tabS << "Discretization_Type.Spatial = " << d_spatialDiscretization
          << std::endl;
      oss << tabS << "Discretization_Type.Time = " << d_timeDiscretization
          << std::endl;
      oss << tabS << "Simulation type = " << d_simType << std::endl;
      oss << tabS << "Time step size = " << d_dt << std::endl;
      oss << tabS << "Restart active = " << d_isRestartActive << std::endl;
      oss << tabS << std::endl;
 
      return oss.str();
    }

References d_dt, d_isRestartActive, d_simType, d_spatialDiscretization, d_timeDiscretization, fields(), util::io::getTabS(), and inp::printFields().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFromJson()

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

inline

Reads from json object.

Definition at line 229 of file modelDeck.h.

                                     {
      if (j.empty())
        return;
 
      readFields(*this, j, fields());
 
      d_spatialDiscretization = j.at("Discretization_Type").at("Spatial");
      d_timeDiscretization = j.at("Discretization_Type").at("Time");
      if (d_timeDiscretization == "central_difference" or
          d_timeDiscretization == "velocity_verlet")
        d_simType = "explicit";
 
      d_rigidParticles.clear();
      if (j.find("Rigid_Particles") != j.end()) {
        for (const auto &r : j.at("Rigid_Particles")) {
          const double mass = r.value("Mass", -1.);
          if (!(mass > 0.)) {
            throw std::runtime_error(
                util::io::Msg()
                << "Error: Model.Rigid_Particles entries need Mass > 0.\n");
          }
          d_rigidParticles.emplace_back(r.at("Id").get<size_t>(), mass);
        }
      }
 
      if (std::abs(d_tFinal) < 1.0E-10 or d_Nt <= 0) {
        throw std::runtime_error(
            util::io::Msg()
            << "Error: Check Final_Time and Time_Steps data.\n");
      }
 
      d_dt = d_tFinal / d_Nt;
    }

References d_dt, d_Nt, d_rigidParticles, d_simType, d_spatialDiscretization, d_tFinal, d_timeDiscretization, fields(), and inp::readFields().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ d_bondBreak

std::string inp::ModelDeck::d_bondBreak

Bond failure criterion: tension (default) or absolute_stretch.

Definition at line 89 of file modelDeck.h.

Referenced by fields().

◆ d_dim

size_t inp::ModelDeck::d_dim

Dimension.

Definition at line 108 of file modelDeck.h.

Referenced by mesh_gen::createParticleMesh(), fields(), mesh_gen::generateBuiltinParticleMeshGmsh(), mesh_gen::gmshMeshGenerateDim(), mesh::Mesh::loadFromTetraElements3D(), and mesh::Mesh::loadFromTriangleElements2D().

◆ d_dt

double inp::ModelDeck::d_dt

Size of time steps.

Definition at line 114 of file modelDeck.h.

Referenced by ModelDeck(), printStr(), and readFromJson().

◆ d_isRestartActive

bool inp::ModelDeck::d_isRestartActive

Flag indicating if this restart problem.

Definition at line 38 of file modelDeck.h.

Referenced by printStr().

◆ d_mpiStrategy

std::string inp::ModelDeck::d_mpiStrategy

MPI domain-decomposition strategy (independent of Particle_Sim_Type).

Allowed: auto (default), none, particle, dof.

auto: Multi_Particle → particle; Single_Particle → dof
none: no domain split (use one MPI rank)
particle: distribute whole particles across ranks (Particle-MPI)
dof: distribute nodes/DOFs across ranks (DOF-MPI)

Definition at line 84 of file modelDeck.h.

Referenced by fields().

◆ d_Nt

size_t inp::ModelDeck::d_Nt

Number of time steps.

Definition at line 117 of file modelDeck.h.

Referenced by fields(), ModelDeck(), and readFromJson().

◆ d_particleSimType

std::string inp::ModelDeck::d_particleSimType

Specify if this is single or multi particle simulation Expected value is either 'Single_Particle' or 'Multi_Particle'.

This flag is used to populate input deck data. For the case when we consider single particle and its deformation, one do not have to specify data such as zones and contact.

Definition at line 73 of file modelDeck.h.

Referenced by fields().

◆ d_populateElementNodeConnectivity

bool inp::ModelDeck::d_populateElementNodeConnectivity

Flag to indicate if we should populate element-node connectivity data in meshes.

Definition at line 62 of file modelDeck.h.

Referenced by fields(), mesh::Mesh::loadFromTetraElements3D(), and mesh::Mesh::loadFromTriangleElements2D().

◆ d_quadOrder

size_t inp::ModelDeck::d_quadOrder

Order of quadrature approximation for strain and stress computation (default is 1)

Definition at line 65 of file modelDeck.h.

Referenced by fields().

◆ d_rigidParticles

std::vector<std::pair<size_t, double> > inp::ModelDeck::d_rigidParticles

Rigid translating particles: {"Id": <id>, "Mass": <mass>}. Nodal force densities are set to density * (net force / Mass).

Definition at line 95 of file modelDeck.h.

Referenced by readFromJson().

◆ d_seed

int inp::ModelDeck::d_seed

Seed for random calculations (if any)

Definition at line 120 of file modelDeck.h.

Referenced by fields().

◆ d_selfContact

std::string inp::ModelDeck::d_selfContact

Intra-body self-contact law name (default broken_bond_kn).

Definition at line 100 of file modelDeck.h.

Referenced by fields().

◆ d_simType

std::string inp::ModelDeck::d_simType

Simulation type.

List of allowed values are:

explicit
implicit

Definition at line 35 of file modelDeck.h.

Referenced by ModelDeck(), printStr(), and readFromJson().

◆ d_spatialDiscretization

std::string inp::ModelDeck::d_spatialDiscretization

Tag for spatial discretization.

List of allowed values are:

**finite_difference**
**weak_finite_element**
**nodal_finite_element**
**truss_finite_element**

Definition at line 49 of file modelDeck.h.

Referenced by mesh::Mesh::loadFromTetraElements3D(), mesh::Mesh::loadFromTriangleElements2D(), printStr(), and readFromJson().

◆ d_tFinal

double inp::ModelDeck::d_tFinal

Final simulation time.

Definition at line 111 of file modelDeck.h.

Referenced by fields(), ModelDeck(), and readFromJson().

◆ d_timeDiscretization

std::string inp::ModelDeck::d_timeDiscretization

Tag for time discretization.

List of allowed values are:

empty string
**central_difference**
**velocity_verlet**

Definition at line 59 of file modelDeck.h.

Referenced by ModelDeck(), printStr(), and readFromJson().

◆ d_wallContact

std::string inp::ModelDeck::d_wallContact

Wall contact representation: meshed (default) or analytical_plane.

Definition at line 105 of file modelDeck.h.

Referenced by fields().

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ ModelDeck() [1/2]

◆ ModelDeck() [2/2]

Member Function Documentation

◆ fields()

◆ getExampleJson()

◆ print()

◆ printStr()

◆ readFromJson()

Field Documentation

◆ d_bondBreak

◆ d_dim

◆ d_dt

◆ d_isRestartActive

◆ d_mpiStrategy

◆ d_Nt

◆ d_particleSimType

◆ d_populateElementNodeConnectivity

◆ d_quadOrder

◆ d_rigidParticles

◆ d_seed

◆ d_selfContact

◆ d_simType

◆ d_spatialDiscretization

◆ d_tFinal

◆ d_timeDiscretization

◆ d_wallContact