inp::RestartDeck Struct Reference

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

#include <restartDeck.h>

Collaboration diagram for inp::RestartDeck:

Public Member Functions
	RestartDeck (std::string file, size_t step=0, bool changeRefFreeDofs=false)
	Constructor.
	RestartDeck (const json &j=json({}))
	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< RestartDeck > > &	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_file
	restart filename
size_t	d_step
	Restart time step.
bool	d_changeRefFreeDofs
	Change only those particles/walls which have any one of its nodes dof free.

Detailed Description

Structure to read and store restart related data input.

Definition at line 26 of file restartDeck.h.

Constructor & Destructor Documentation

RestartDeck() [1/2]

inp::RestartDeck::RestartDeck ( std::string  file, size_t  step = 0, bool  changeRefFreeDofs = false  )

inline

Constructor.

Definition at line 41 of file restartDeck.h.

      : d_file(file), d_step(step), d_changeRefFreeDofs(changeRefFreeDofs) {};

RestartDeck() [2/2]

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

inline

Constructor.

Definition at line 47 of file restartDeck.h.

                                     {}))
        : d_file(""), d_step(0), d_changeRefFreeDofs(false) {
      readFromJson(j);
    };

Member Function Documentation

fields()

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

inlinestatic

Returns example JSON object for ModelDeck configuration.

Returns

JSON object with example configuration

Definition at line 57 of file restartDeck.h.

                                                         {
      static const std::vector<Field<RestartDeck>> f = {
          field(&RestartDeck::d_file, "File", std::string(),
                "File the state is read from"),
          field(&RestartDeck::d_step, "Step", size_t(0),
                "Step the state was written at"),
          field(&RestartDeck::d_changeRefFreeDofs,
                "Change_Reference_Free_Dofs", false,
                "Move only the bodies that have a free degree of freedom"),
      };
      return f;
    }

References d_changeRefFreeDofs, d_file, d_step, 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::RestartDeck::getExampleJson ( const char *  )

staticdelete

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

A file name passed on its own would convert to a JSON string and be read as a block with no keys, so such a call is rejected when compiling.

getExampleJson() [2/3]

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

inlinestatic

Returns the block with the given fields set.

A restart is requested by naming a file. Without one the block is empty, and the model starts from the initial condition.

Parameters

given

Field names and values to set, checked against the table

Returns

JSON object for this deck

Definition at line 79 of file restartDeck.h.

                                                                 {
      json j = applyGiven(given, fields());
      if (j.at("File").get<std::string>().empty())
        return json({});
      return j;
    }

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

Here is the call graph for this function:

getExampleJson() [3/3]

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

staticdelete

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

A file name passed on its own would convert to a JSON string and be read as a block with no keys, so such a call is rejected when compiling.

print()

void inp::RestartDeck::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 140 of file restartDeck.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string inp::RestartDeck::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 124 of file restartDeck.h.

                                                      {
      auto tabS = util::io::getTabS(nt);
      std::ostringstream oss;
      oss << tabS << "------- RestartDeck --------" << std::endl << std::endl;
      printFields(*this, oss, fields(), tabS);
      oss << tabS << std::endl;
 
      return oss.str();
    }

References 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::RestartDeck::readFromJson ( const json &  j )

inline

Reads from json object.

Parameters

j	JSON object

Definition at line 101 of file restartDeck.h.

                                     {
      if (j.empty())
        return;
      readFields(*this, j, fields());
    }

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

Here is the call graph for this function:

writeToJson()

json inp::RestartDeck::writeToJson ( ) const

inline

Returns this deck as a JSON object.

Returns

JSON object for this deck

Definition at line 111 of file restartDeck.h.

                             {
      json j = json::object();
      writeFields(*this, j, fields());
      return j;
    }

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

Here is the call graph for this function:

Field Documentation

d_changeRefFreeDofs

bool inp::RestartDeck::d_changeRefFreeDofs

Change only those particles/walls which have any one of its nodes dof free.

Definition at line 36 of file restartDeck.h.

Referenced by fields().

d_file

std::string inp::RestartDeck::d_file

restart filename

Definition at line 29 of file restartDeck.h.

Referenced by fields().

d_step

size_t inp::RestartDeck::d_step

Restart time step.

Definition at line 32 of file restartDeck.h.

Referenced by fields().

---

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

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