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

#include <particleDeck.h>

Collaboration diagram for inp::ParticleDeck:

Public Member Functions
	ParticleDeck (const json &j=json({}), std::string particleSimType="Multi_Particle")
	Constructor.

void	readFromJson (const json &j)

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

void	readParticleMeshFromJson (const json &j)

void	readParticleMaterialFromJson (const json &j)

void	readParticleContactFromJson (const json &j)

void	readParticleNeighborFromJson (const json &j)

void	readParticleGenFromJson (const json &j)

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 json	getParticleGeomExampleJson (std::vector< geom::GeomData > pGeomVec=std::vector< geom::GeomData >())
	Returns example JSON object for ModelDeck configuration.

static json	getParticleMeshExampleJson (std::vector< std::string > filenameVec=std::vector< std::string >(), std::vector< double > meshSizesVec=std::vector< double >())
	Returns example JSON object for ModelDeck configuration.

static json	getParticleMaterialExampleJson (size_t nSets=0)
	Returns example JSON object for ModelDeck configuration.

static json	getParticleContactExampleJson (size_t nSets=0)
	Returns example JSON object for ModelDeck configuration.

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

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

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

std::vector< geom::GeomData >	d_pGeomVec
	Particle geometry data.

std::vector< inp::MeshDeck >	d_pMeshVec
	Particle mesh data.

std::vector< inp::MaterialDeck >	d_pMaterialVec
	Particle material data.

inp::ContactDeck	d_contactDeck
	Particle contact data.

inp::PNeighborDeck	d_pNeighDeck
	Neighbor search data.

inp::PGenDeck	d_pGenDeck
	Particle generation data.

Detailed Description

Structure to read and store particle related input data.

Definition at line 31 of file particleDeck.h.

Constructor & Destructor Documentation

◆ ParticleDeck()

inp::ParticleDeck::ParticleDeck	(	const json &	j = `json({})`,
		std::string	particleSimType = `"Multi_Particle"`
	)

inline

Constructor.

Definition at line 62 of file particleDeck.h.

                                    {}), std::string particleSimType = "Multi_Particle") {
    d_particleSimType = particleSimType;
    readFromJson(j);
  };

Member Function Documentation

◆ getParticleContactExampleJson()

static json inp::ParticleDeck::getParticleContactExampleJson ( size_t nSets = 0 )

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns: JSON object with example configuration

Definition at line 260 of file particleDeck.h.

                                                              {
    return inp::ContactDeck::getExampleJson(json{{"Sets", nSets}});
  }

References inp::ContactDeck::getExampleJson().

Referenced by anonymous_namespace{main.cpp}::buildBhatInputJson(), anonymous_namespace{main.cpp}::buildImpactInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), anonymous_namespace{main.cpp}::buildInputJson(), getInputJson(), and anonymous_namespace{main.cpp}::makeDeck().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParticleGenExampleJson()

static json inp::ParticleDeck::getParticleGenExampleJson ( const json & given = json::object() )

inlinestatic

Returns the particle generation block with the given fields set.

Parameters

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

Returns: JSON object for the particle generation block

Definition at line 287 of file particleDeck.h.

                                                                          {
    return inp::PGenDeck::getExampleJson(given);
  }

References inp::PGenDeck::getExampleJson().

Here is the call graph for this function:

◆ getParticleGeomExampleJson()

static json inp::ParticleDeck::getParticleGeomExampleJson ( std::vector< geom::GeomData > pGeomVec = std::vector<geom::GeomData>() )

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns: JSON object with example configuration

Definition at line 95 of file particleDeck.h.

                                                                                                       {
 
    auto nSets = pGeomVec.size();
 
    if (nSets == 0)
      return json({});
 
    auto j = json({{"Sets", nSets}});
 
    for (size_t i = 0; i < nSets; i++) {
      auto js = json({});
      geom::writeGeometry(js, pGeomVec[i]);
      std::string set_name = "Set_" + std::to_string(i+1);
      j[set_name] = js;
    }
 
    return j;
  }

References geom::writeGeometry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParticleMaterialExampleJson()

static json inp::ParticleDeck::getParticleMaterialExampleJson ( size_t nSets = 0 )

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns: JSON object with example configuration

Definition at line 210 of file particleDeck.h.

                                                               {
 
    if (nSets == 0)
      return json({});
 
    auto j = json({{"Sets", nSets}});
    for (size_t i = 0; i < nSets; i++) {
      std::string set_name = "Set_" + std::to_string(i+1);
      j[set_name] = {};
    }
 
    return j;
  }

Here is the caller graph for this function:

◆ getParticleMeshExampleJson()

static json inp::ParticleDeck::getParticleMeshExampleJson	(	std::vector< std::string >	filenameVec = `std::vector<std::string>()`,
		std::vector< double >	meshSizesVec = `std::vector<double>()`
	)

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns: JSON object with example configuration

Definition at line 153 of file particleDeck.h.

                                                            {
 
    auto nSets = filenameVec.size();
 
    if (nSets == 0)
      return json({});
 
    auto j = json({{"Sets", nSets}});
    for (size_t i = 0; i < nSets; i++) {
      double h = meshSizesVec.size() > i ? meshSizesVec[i] : -1.;
      auto js = inp::MeshDeck::getExampleJson(
          json{{"File", filenameVec[i]}, {"Mesh_Size", h}});
 
      std::string set_name = "Set_" + std::to_string(i+1);
      j[set_name] = js;
    }
 
    return j;
  }

References inp::MeshDeck::getExampleJson().

Referenced by getInputJson().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParticleNeighborExampleJson()

static json inp::ParticleDeck::getParticleNeighborExampleJson ( const json & given = json::object() )

inlinestatic

Returns the neighbor block with the given fields set.

Parameters

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

Returns: JSON object for the neighbor block

Definition at line 273 of file particleDeck.h.

                                        {
    return inp::PNeighborDeck::getExampleJson(given);
  }

References inp::PNeighborDeck::getExampleJson().

Here is the call graph for this function:

◆ print()

void inp::ParticleDeck::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 351 of file particleDeck.h.

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

inp::ParticleDeck::printStr

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

Returns the string containing printable information about the object.

Definition particleDeck.h:302

References printStr().

Here is the call graph for this function:

◆ printStr()

std::string inp::ParticleDeck::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 302 of file particleDeck.h.

                                                    {
 
    auto tabS = util::io::getTabS(nt);
    std::ostringstream oss;
    oss << tabS << "------- ParticleDeck --------" << std::endl << std::endl;
 
    oss << tabS << "Number of particle geometry groups  = " << d_pGeomVec.size() << std::endl;
    oss << tabS << "Number of particle mesh groups  = " << d_pMeshVec.size() << std::endl;
    oss << tabS << "Number of particle material groups  = " << d_pMaterialVec.size() << std::endl;
 
    oss << tabS << "Particle geometry data:" << std::endl;
    for (size_t i = 0; i < d_pGeomVec.size(); i++) {
      oss << tabS << "Particle geometry data for group = " << i << std::endl;
      oss << d_pGeomVec[i].printStr(nt + 1, lvl);
    }
 
 
    oss << tabS << "Particle mesh data:" << std::endl;
    for (size_t i = 0; i < d_pMeshVec.size(); i++) {
      oss << tabS << "Particle mesh data for group = " << i << std::endl;
      oss << d_pMeshVec[i].printStr(nt + 1, lvl);
    }
 
    oss << tabS << "Particle material data:" << std::endl;
    for (size_t i = 0; i < d_pMaterialVec.size(); i++) {
      oss << tabS << "Particle material data for group = " << i << std::endl;
      oss << d_pMaterialVec[i].printStr(nt + 1, lvl);
    }
 
    oss << tabS << "Contact data:" << std::endl;
    oss << d_contactDeck.printStr(nt + 1, lvl);
 
    oss << tabS << "Neighbor data:" << std::endl;
    oss << d_pNeighDeck.printStr(nt+1, lvl);
 
    oss << tabS << "Particle generation data:" << std::endl;
    oss << d_pGenDeck.printStr(nt+1, lvl);
 
    oss << tabS << std::endl;
 
    return oss.str();
  }

References d_contactDeck, d_pGenDeck, d_pGeomVec, d_pMaterialVec, d_pMeshVec, d_pNeighDeck, util::io::getTabS(), inp::ContactDeck::printStr(), inp::PGenDeck::printStr(), and inp::PNeighborDeck::printStr().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFromJson()

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

inline

Definition at line 67 of file particleDeck.h.

                                   {
 
    if (j.find("Particle") != j.end())
      readParticleGeomFromJson(j.at("Particle"));
 
    if (j.find("Mesh") != j.end())
      readParticleMeshFromJson(j.at("Mesh"));
 
    if (j.find("Material") != j.end())
      readParticleMaterialFromJson(j.at("Material"));
 
    if (j.find("Contact") != j.end())
      readParticleContactFromJson(j.at("Contact"));
 
    if (j.find("Neighbor") != j.end())
      readParticleNeighborFromJson(j.at("Neighbor"));
 
    if (j.find("Particle_Generation") != j.end())
      readParticleGenFromJson(j.at("Particle_Generation"));
 
    if (d_pGeomVec.size() != d_pMeshVec.size())
      throw std::runtime_error("Number of particle geometry groups must be equal to number of particle mesh groups");
  }

References d_pGeomVec, d_pMeshVec, readParticleContactFromJson(), readParticleGenFromJson(), readParticleGeomFromJson(), readParticleMaterialFromJson(), readParticleMeshFromJson(), and readParticleNeighborFromJson().

Here is the call graph for this function:

◆ readParticleContactFromJson()

void inp::ParticleDeck::readParticleContactFromJson ( const json & j )

inline

Definition at line 264 of file particleDeck.h.

                                                  {
    d_contactDeck.readFromJson(j);
  }

References d_contactDeck, and inp::ContactDeck::readFromJson().

Referenced by readFromJson().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readParticleGenFromJson()

void inp::ParticleDeck::readParticleGenFromJson ( const json & j )

inline

Definition at line 291 of file particleDeck.h.

                                              {
    d_pGenDeck.readFromJson(j);
  }

References d_pGenDeck, and inp::PGenDeck::readFromJson().

Referenced by readFromJson().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readParticleGeomFromJson()

void inp::ParticleDeck::readParticleGeomFromJson ( const json & j )

inline

Reads from json object.

Definition at line 117 of file particleDeck.h.

                                               {
 
    if (j.empty())
      return;
 
    if (d_particleSimType == "Multi_Particle") {
      auto nSets = j.value("Sets", size_t(0));
 
      d_pGeomVec.resize(nSets);
 
      for (size_t i = 0; i < nSets; i++) {
        auto set_name = "Set_" + std::to_string(i + 1);
        if (j.find(set_name) == j.end())
          throw std::runtime_error("Set " + set_name + " not found in particle geometry");
 
        auto js = j.at(set_name);
 
        // read
        geom::readGeometry(js, d_pGeomVec[i]);
        // create
        geom::createGeomObject(d_pGeomVec[i]);
      }
    } else if (d_particleSimType == "Single_Particle") {
      d_pGeomVec.resize(1);
      auto js = j.find("Set_1") == j.end()? j : j.at("Set_1");
      if (js.find("Type") != js.end()) {
        geom::readGeometry(js, d_pGeomVec[0]);
        geom::createGeomObject(d_pGeomVec[0]);
      }
    }
  }

References geom::createGeomObject(), d_particleSimType, d_pGeomVec, and geom::readGeometry().

Referenced by readFromJson().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readParticleMaterialFromJson()

void inp::ParticleDeck::readParticleMaterialFromJson ( const json & j )

inline

Definition at line 224 of file particleDeck.h.

                                                   {
    if (j.empty())
      return;
 
    if (d_particleSimType == "Multi_Particle") {
      auto nSets = j.value("Sets", size_t(0));
      d_pMaterialVec.resize(nSets);
 
      for (size_t i = 0; i < nSets; i++) {
        auto set_name = "Set_" + std::to_string(i + 1);
        if (j.find(set_name) == j.end())
          throw std::runtime_error("Set " + set_name + " not found in particle mesh");
 
        auto js = j.at(set_name);
 
        // copy this set from previous set?
        int copy_set = js.value("Copy_Data", int(-1));
        if (copy_set != -1) {
          std::string copy_set_tag = "Set_" + std::to_string(copy_set);
          auto js_copy = j.at(copy_set_tag);
          d_pMaterialVec[i].readFromJson(js_copy);
        } else {
          d_pMaterialVec[i].readFromJson(js);
        }
      } // loop over sets
    } else if (d_particleSimType == "Single_Particle") {
      d_pMaterialVec.resize(1);
      auto js = j.find("Set_1") == j.end()? j : j.at("Set_1");
      d_pMaterialVec[0].readFromJson(js);
    }
  }

References d_particleSimType, and d_pMaterialVec.

Referenced by readFromJson().

Here is the caller graph for this function:

◆ readParticleMeshFromJson()

void inp::ParticleDeck::readParticleMeshFromJson ( const json & j )

inline

Definition at line 174 of file particleDeck.h.

                                               {
    if (j.empty())
      return;
 
    if (d_particleSimType == "Multi_Particle") {
      auto nSets = j.value("Sets", size_t(0));
      d_pMeshVec.resize(nSets);
 
      for (size_t i = 0; i < nSets; i++) {
        auto set_name = "Set_" + std::to_string(i + 1);
 
        if (j.find(set_name) == j.end())
          throw std::runtime_error("Set " + set_name + " not found in particle mesh");
 
        auto js = j.at(set_name);
 
        // copy this set from a previous set?
        int copy_set = js.value("Copy_Data", int(-1));
        if (copy_set != -1) {
          std::string copy_set_tag = "Set_" + std::to_string(copy_set);
          auto js_copy = j.at(copy_set_tag);
          d_pMeshVec[i].readFromJson(js_copy);
        } else
          d_pMeshVec[i].readFromJson(js);
      }
    } else if (d_particleSimType == "Single_Particle") {
      d_pMeshVec.resize(1);
      auto js = j.find("Set_1") == j.end()? j : j.at("Set_1");
      d_pMeshVec[0].readFromJson(js);
    }
  }

References d_particleSimType, and d_pMeshVec.

Referenced by readFromJson().

Here is the caller graph for this function:

◆ readParticleNeighborFromJson()

void inp::ParticleDeck::readParticleNeighborFromJson ( const json & j )

inline

Definition at line 278 of file particleDeck.h.

                                                   {
    d_pNeighDeck.readFromJson(j);
  }

References d_pNeighDeck, and inp::PNeighborDeck::readFromJson().

Referenced by readFromJson().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ d_contactDeck

inp::ContactDeck inp::ParticleDeck::d_contactDeck

Particle contact data.

Definition at line 51 of file particleDeck.h.

Referenced by printStr(), and readParticleContactFromJson().

◆ d_particleSimType

std::string inp::ParticleDeck::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 39 of file particleDeck.h.

Referenced by readParticleGeomFromJson(), readParticleMaterialFromJson(), and readParticleMeshFromJson().

◆ d_pGenDeck

inp::PGenDeck inp::ParticleDeck::d_pGenDeck

Particle generation data.

Definition at line 57 of file particleDeck.h.

Referenced by printStr(), and readParticleGenFromJson().

◆ d_pGeomVec

std::vector<geom::GeomData> inp::ParticleDeck::d_pGeomVec

Particle geometry data.

Definition at line 42 of file particleDeck.h.

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

◆ d_pMaterialVec

std::vector<inp::MaterialDeck> inp::ParticleDeck::d_pMaterialVec

Particle material data.

Definition at line 48 of file particleDeck.h.

Referenced by printStr(), and readParticleMaterialFromJson().

◆ d_pMeshVec

std::vector<inp::MeshDeck> inp::ParticleDeck::d_pMeshVec

Particle mesh data.

Definition at line 45 of file particleDeck.h.

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

◆ d_pNeighDeck

inp::PNeighborDeck inp::ParticleDeck::d_pNeighDeck

Neighbor search data.

Definition at line 54 of file particleDeck.h.

Referenced by printStr(), and readParticleNeighborFromJson().

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ ParticleDeck()

Member Function Documentation

◆ getParticleContactExampleJson()

◆ getParticleGenExampleJson()

◆ getParticleGeomExampleJson()

◆ getParticleMaterialExampleJson()

◆ getParticleMeshExampleJson()

◆ getParticleNeighborExampleJson()

◆ print()

◆ printStr()

◆ readFromJson()

◆ readParticleContactFromJson()

◆ readParticleGenFromJson()

◆ readParticleGeomFromJson()

◆ readParticleMaterialFromJson()

◆ readParticleMeshFromJson()

◆ readParticleNeighborFromJson()

Field Documentation

◆ d_contactDeck

◆ d_particleSimType

◆ d_pGenDeck

◆ d_pGeomVec

◆ d_pMaterialVec

◆ d_pMeshVec

◆ d_pNeighDeck