inp::TestDeck Struct Reference

Structure to read and store test-related input data. More...

#include <testDeck.h>

Collaboration diagram for inp::TestDeck:

Public Member Functions
	TestDeck (const json &j=json({}))
	Constructor.
	TestDeck (std::string testName, size_t particleIdCompressiveTest=0, size_t particleForceDirectionCompressiveTest=0)
	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 testName="", size_t particleIdCompressiveTest=0, size_t particleForceDirectionCompressiveTest=0)
	Returns example JSON object for ModelDeck configuration.

Data Fields
std::string	d_testName
	Specify test name (if any)
size_t	d_particleIdCompressiveTest
	if it is a compressive test, specify wall id and direction
size_t	d_particleForceDirectionCompressiveTest
	if it is a compressive test, specify force direction on wall

Detailed Description

Structure to read and store test-related input data.

Definition at line 25 of file testDeck.h.

Constructor & Destructor Documentation

TestDeck() [1/2]

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

inline

Constructor.

Definition at line 39 of file testDeck.h.

                                  {}))
      : d_testName(""), d_particleIdCompressiveTest(0), d_particleForceDirectionCompressiveTest(0) {
      readFromJson(j);
    };

TestDeck() [2/2]

inp::TestDeck::TestDeck ( std::string  testName, size_t  particleIdCompressiveTest = 0, size_t  particleForceDirectionCompressiveTest = 0  )

inline

Constructor.

Definition at line 47 of file testDeck.h.

          : d_testName(testName),
          d_particleIdCompressiveTest(particleIdCompressiveTest),
          d_particleForceDirectionCompressiveTest(particleForceDirectionCompressiveTest) {};

Member Function Documentation

getExampleJson()

static json inp::TestDeck::getExampleJson ( std::string  testName = "", size_t  particleIdCompressiveTest = 0, size_t  particleForceDirectionCompressiveTest = 0  )

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns

JSON object with example configuration

Definition at line 57 of file testDeck.h.

                                                          {
 
      if (testName == "")
        return json({});
 
      auto j = json({"Test_Name", testName});
 
      if (testName == "Compressive_Test") {
        j["Compressive_Test"] = json{{"Wall_Id", particleIdCompressiveTest},
          {"Wall_Force_Direction", particleForceDirectionCompressiveTest}};
      }
 
      return j;
    }

print()

void inp::TestDeck::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 118 of file testDeck.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string inp::TestDeck::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 99 of file testDeck.h.

                                                      {
      auto tabS = util::io::getTabS(nt);
      std::ostringstream oss;
      oss << tabS << "------- TestDeck --------" << std::endl << std::endl;
      oss << tabS << "Test name = " << d_testName << std::endl;
      oss << tabS << "Particle id for compressive test = " << d_particleIdCompressiveTest << std::endl;
      oss << tabS << "Particle force direction for compressive test = " << d_particleForceDirectionCompressiveTest <<
          std::endl;
      oss << tabS << std::endl;
 
      return oss.str();
    }

References d_particleForceDirectionCompressiveTest, d_particleIdCompressiveTest, d_testName, and util::io::getTabS().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

readFromJson()

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

inline

Reads from json object.

Definition at line 76 of file testDeck.h.

                                     {
      if (j.empty())
        return;
 
      d_testName = j.value("Test_Name", "");
      const bool compressive =
          d_testName == "Compressive_Test" || d_testName == "compressive_test";
      if (compressive) {
        if (j.find("Compressive_Test") == j.end())
          throw std::runtime_error("Compressive test requires Compressive_Test section");
 
        d_particleIdCompressiveTest = j.at("Compressive_Test").value("Wall_Id", 0);
        d_particleForceDirectionCompressiveTest = j.at("Compressive_Test").value("Wall_Force_Direction", 0);
      }
    }

References d_particleForceDirectionCompressiveTest, d_particleIdCompressiveTest, and d_testName.

Field Documentation

d_particleForceDirectionCompressiveTest

size_t inp::TestDeck::d_particleForceDirectionCompressiveTest

if it is a compressive test, specify force direction on wall

Definition at line 33 of file testDeck.h.

Referenced by printStr(), and readFromJson().

d_particleIdCompressiveTest

size_t inp::TestDeck::d_particleIdCompressiveTest

if it is a compressive test, specify wall id and direction

Definition at line 30 of file testDeck.h.

Referenced by printStr(), and readFromJson().

d_testName

std::string inp::TestDeck::d_testName

Specify test name (if any)

Definition at line 27 of file testDeck.h.

Referenced by printStr(), and readFromJson().

---

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

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