inp::PGenDeck Struct Reference

Structure to read and store particle generation data, such as particle locations and group file. More...

#include <pGenDeck.h>

Collaboration diagram for inp::PGenDeck:

Public Member Functions
	PGenDeck (const json &j=json({}))
	Constructor.
	PGenDeck (std::string genMethod, json pGenJson=json({}), bool genWithRandomRotation=true)
	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 json	getExampleJson (std::string genMethod="From_File")
	Returns example JSON object for ModelDeck configuration.

Data Fields
std::string	d_genMethod
	Particle generation method.
json	d_pGenJson
	Json object loaded from the input json file or jason file for particle generation.
bool	d_genWithRandomRotation
	Random rotation of particles if orientation is not provided.

Detailed Description

Structure to read and store particle generation data, such as particle locations and group file.

Definition at line 27 of file pGenDeck.h.

Constructor & Destructor Documentation

PGenDeck() [1/2]

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

inline

Constructor.

Definition at line 48 of file pGenDeck.h.

                                  {}))
      : d_genMethod("Use_Particle_Geometry"),
        d_pGenJson({}), d_genWithRandomRotation(true) {
      readFromJson(j);
    };

PGenDeck() [2/2]

inp::PGenDeck::PGenDeck ( std::string  genMethod, json  pGenJson = json({}), bool  genWithRandomRotation = true  )

inline

Constructor.

Definition at line 57 of file pGenDeck.h.

                                                       {}), bool genWithRandomRotation = true)
        : d_genMethod(genMethod),
          d_pGenJson(pGenJson), d_genWithRandomRotation(genWithRandomRotation) {};

Member Function Documentation

getExampleJson()

static json inp::PGenDeck::getExampleJson ( std::string  genMethod = "From_File" )

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns

JSON object with example configuration

Definition at line 65 of file pGenDeck.h.

                                                                  {
 
      auto j = json({{"Method", "From_File"}, {"Random_Rotation", true}});
      return j;
    }

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(), anonymous_namespace{main.cpp}::buildInputJson(), getInputJson(), and inp::ParticleDeck::getParticleGenExampleJson().

Here is the caller graph for this function:

print()

void inp::PGenDeck::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 124 of file pGenDeck.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string inp::PGenDeck::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 96 of file pGenDeck.h.

                                                      {
 
      auto tabS = util::io::getTabS(nt);
      std::ostringstream oss;
      oss << tabS << "------- PGenDeck --------" << std::endl << std::endl;
      oss << tabS << "Method = " << d_genMethod << std::endl;
      oss << tabS << "Random rotation of particles = " << d_genWithRandomRotation << std::endl;
      size_t nParticles = d_pGenJson.value("N", 0);
      oss << tabS << "Number of particles in json object = " << nParticles << std::endl;
      oss << tabS << "Data for first five particles: " << std::endl;
      if (nParticles > 0) {
        nParticles = nParticles > 5 ? 5 : nParticles;
        for (size_t i=0; i< nParticles; i++) {
          oss << tabS << "Particle number = " << i << std::endl;
          oss << tabS << d_pGenJson.at(std::to_string(i)) << std::endl;
        }
      }
      oss << tabS << std::endl;
 
      return oss.str();
    }

References d_genMethod, d_genWithRandomRotation, d_pGenJson, and util::io::getTabS().

Referenced by print(), and inp::ParticleDeck::printStr().

Here is the call graph for this function:

Here is the caller graph for this function:

readFromJson()

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

inline

Reads from json object.

Definition at line 74 of file pGenDeck.h.

                                     {
      if (j.empty())
        return;
 
      d_genMethod = j.value("Method", std::string("Use_Particle_Geometry"));
      d_genWithRandomRotation = j.value("Random_Rotation", true);
 
      if (d_genMethod == "From_File") {
        if (j.find("Data") == j.end())
          throw std::runtime_error("Need information inside key Data.");
 
        d_pGenJson = j.at("Data");
      }
    }

References d_genMethod, d_genWithRandomRotation, and d_pGenJson.

Referenced by inp::ParticleDeck::readParticleGenFromJson().

Here is the caller graph for this function:

Field Documentation

d_genMethod

std::string inp::PGenDeck::d_genMethod

Particle generation method.

"From_File" means particle location, radius and other details will be loaded from the input json file. Use key 'Particle_Generation' to provide the data.

"Use_Particle_Geometry" means particle geometry will be used to generate particles.

Definition at line 37 of file pGenDeck.h.

Referenced by printStr(), and readFromJson().

d_genWithRandomRotation

bool inp::PGenDeck::d_genWithRandomRotation

Random rotation of particles if orientation is not provided.

Definition at line 43 of file pGenDeck.h.

Referenced by printStr(), and readFromJson().

d_pGenJson

json inp::PGenDeck::d_pGenJson

Json object loaded from the input json file or jason file for particle generation.

Definition at line 40 of file pGenDeck.h.

Referenced by printStr(), and readFromJson().

---

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

• /home/user/project/src/inp/pGenDeck.h