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.
json	writeToJson () const
	Returns this deck as a 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< PGenDeck > > &	fields ()
	Returns example JSON object for ModelDeck configuration.
static json	getExampleJson (const json &given=json::object())
	Returns the block with the given fields set.
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
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 28 of file pGenDeck.h.

Constructor & Destructor Documentation

PGenDeck() [1/2]

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

inline

Constructor.

Definition at line 49 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 58 of file pGenDeck.h.

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

Member Function Documentation

fields()

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

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns

JSON object with example configuration

Definition at line 66 of file pGenDeck.h.

                                                      {
      static const std::vector<Field<PGenDeck>> f = {
          field(&PGenDeck::d_genMethod, "Method", std::string("From_File"),
                "Where the particle positions come from",
                {{"From_File", "Use_Particle_Geometry"}, {}, {}}),
          field(&PGenDeck::d_genWithRandomRotation, "Random_Rotation", true,
                "Give each particle a random orientation when none is given"),
      };
      return f;
    }

References d_genMethod, d_genWithRandomRotation, and inp::field().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getExampleJson() [1/3]

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

staticdelete

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

A string converts to a JSON string, which would otherwise bind to the overload above and be read as a block with no keys. Deleting these makes that a compile error rather than a failure when the deck is built.

getExampleJson() [2/3]

static json inp::PGenDeck::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 82 of file pGenDeck.h.

                                                                 {
      return applyGiven(given, fields(), {"Data"});
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getExampleJson() [3/3]

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

staticdelete

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

A string converts to a JSON string, which would otherwise bind to the overload above and be read as a block with no keys. Deleting these makes that a compile error rather than a failure when the deck is built.

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 162 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 135 of file pGenDeck.h.

                                                      {
 
      auto tabS = util::io::getTabS(nt);
      std::ostringstream oss;
      oss << tabS << "------- PGenDeck --------" << std::endl << std::endl;
      printFields(*this, oss, fields(), tabS);
      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_pGenJson, fields(), util::io::getTabS(), and inp::printFields().

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.

Parameters

j	JSON object

Definition at line 102 of file pGenDeck.h.

                                     {
      if (j.empty())
        return;
      readFields(*this, j, fields());
 
      // The positions themselves are a block of their own, not a field.
      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_pGenJson, fields(), and inp::readFields().

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

Here is the call graph for this function:

Here is the caller graph for this function:

writeToJson()

json inp::PGenDeck::writeToJson ( ) const

inline

Returns this deck as a JSON object.

Returns

JSON object for this deck

Definition at line 120 of file pGenDeck.h.

                             {
      json j = json::object();
      writeFields(*this, j, fields());
      if (d_genMethod == "From_File")
        j["Data"] = d_pGenJson;
      return j;
    }

References d_genMethod, d_pGenJson, fields(), and inp::writeFields().

Here is the call 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 38 of file pGenDeck.h.

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

d_genWithRandomRotation

bool inp::PGenDeck::d_genWithRandomRotation

Random rotation of particles if orientation is not provided.

Definition at line 44 of file pGenDeck.h.

Referenced by fields().

d_pGenJson

json inp::PGenDeck::d_pGenJson

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

Definition at line 41 of file pGenDeck.h.

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

---

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

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