inp::Zone Struct Reference

User-input data for zones. More...

#include <zoneDeck.h>

Collaboration diagram for inp::Zone:

Public Member Functions
	Zone ()
	Constructor.
	Zone (const Zone &z)
	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
util::geometry::GeomData	d_zoneGeomData
	Zone geometry data.
size_t	d_zoneId
	Specify zone to which this particle belongs to.

Detailed Description

User-input data for zones.

Definition at line 27 of file zoneDeck.h.

Constructor & Destructor Documentation

Zone() [1/2]

inp::Zone::Zone ( )

inline

Constructor.

Definition at line 38 of file zoneDeck.h.

: d_zoneGeomData(){};

Zone() [2/2]

inp::Zone::Zone ( const Zone &  z )

inline

Constructor.

Parameters

z	Another zone object

Definition at line 45 of file zoneDeck.h.

      : d_zoneGeomData(z.d_zoneGeomData),
        d_zoneId(z.d_zoneId) {};

Member Function Documentation

print()

void inp::Zone::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 zoneDeck.h.

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

References printStr().

Here is the call graph for this function:

printStr()

std::string inp::Zone::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 56 of file zoneDeck.h.

                                                    {
 
    auto tabS = util::io::getTabS(nt);
    std::ostringstream oss;
    oss << tabS << "------- Zone --------" << std::endl << std::endl;
    oss << tabS << "Zone id = " << d_zoneId << std::endl;
    oss << tabS << "Zone geometry data: " << std::endl;
    oss << d_zoneGeomData.printStr(nt+1, lvl);
 
    return oss.str();
  }

References d_zoneGeomData, d_zoneId, util::io::getTabS(), and util::geometry::GeomData::printStr().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

d_zoneGeomData

util::geometry::GeomData inp::Zone::d_zoneGeomData

Zone geometry data.

Definition at line 30 of file zoneDeck.h.

Referenced by printStr(), and inp::Input::setZoneData().

d_zoneId

size_t inp::Zone::d_zoneId

Specify zone to which this particle belongs to.

Definition at line 33 of file zoneDeck.h.

Referenced by printStr().

---

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

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