inp::PICDeck Struct Reference

User-input data for particle neighbor search. More...

#include <pICDeck.h>

Collaboration diagram for inp::PICDeck:

Public Member Functions
	PICDeck ()
	Constructor.
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.

Data Fields
bool	d_icActive
	Specify if particle initial condition is active.
util::Point	d_icVec
	Initial velocity vector.
std::vector< size_t >	d_pList
	List of particles (if any)
std::vector< size_t >	d_pNotList
	List of particles to not include (if any)

Detailed Description

User-input data for particle neighbor search.

Definition at line 24 of file pICDeck.h.

Constructor & Destructor Documentation

PICDeck()

inp::PICDeck::PICDeck ( )

inline

Constructor.

Definition at line 41 of file pICDeck.h.

: d_icActive(false), d_icVec(){};

Member Function Documentation

print()

void inp::PICDeck::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 74 of file pICDeck.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string inp::PICDeck::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 50 of file pICDeck.h.

                                                    {
 
    auto tabS = util::io::getTabS(nt);
    std::ostringstream oss;
    oss << tabS << "------- PICDeck --------" << std::endl << std::endl;
    oss << tabS << "IC active  = " << d_icActive << std::endl;
    oss << tabS << "IC vector = " << d_icVec.printStr(0, 0) << std::endl;
    if (!d_pList.empty())
      oss << tabS << "Particle list = ["
          << util::io::printStr<size_t>(d_pList, 0) << "]" << std::endl;
    if (!d_pNotList.empty())
      oss << tabS << "Particle excluded list = ["
          << util::io::printStr<size_t>(d_pNotList, 0) << "]" << std::endl;
    oss << tabS << std::endl;
 
    return oss.str();
  }

References d_icActive, d_icVec, d_pList, d_pNotList, util::io::getTabS(), and util::Point::printStr().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

d_icActive

bool inp::PICDeck::d_icActive

Specify if particle initial condition is active.

Definition at line 27 of file pICDeck.h.

Referenced by printStr().

d_icVec

util::Point inp::PICDeck::d_icVec

Initial velocity vector.

Definition at line 30 of file pICDeck.h.

Referenced by printStr().

d_pList

std::vector<size_t> inp::PICDeck::d_pList

List of particles (if any)

Definition at line 33 of file pICDeck.h.

Referenced by printStr().

d_pNotList

std::vector<size_t> inp::PICDeck::d_pNotList

List of particles to not include (if any)

Definition at line 36 of file pICDeck.h.

Referenced by printStr().

---

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

• /home/user/project/src/inp/pdecks/pICDeck.h