Representation of a Cartesian grid topology definition.
More...
#include <pearl/CartTopology.h>
|
(Note that these are not member functions.)
|
|
std::ostream & | operator<< (std::ostream &stream, const CartTopology &item) |
| Stream output operator. More...
|
|
The CartTopology class provides a representation of a Cartesian grid topology definition.
◆ CoordinateContainer
◆ DimensionContainer
◆ IdType
◆ CartTopology()
Creates a new instance with the given global identifier id
, topology name
, associated communicator
, and list of dimensions
.
- Parameters
-
id | Global Cartesian grid topology identifier |
name | Name (label) of the topology |
communicator | Associated communicator |
dimensions | List of topology dimension definition objects \n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
|
- Exceptions
-
std::bad_alloc | on failure to allocate storage |
◆ ~CartTopology()
virtual pearl::CartTopology::~CartTopology |
( |
| ) |
|
|
virtual |
Destroys the CartTopology instance.
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
◆ getCommunicator()
const Communicator& pearl::CartTopology::getCommunicator |
( |
| ) |
const |
Returns the communicator definition associated to the topology.
- Returns
- Associated communicator
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
◆ getDimension()
const CartDimension& pearl::CartTopology::getDimension |
( |
uint8_t |
index | ) |
const |
Returns the Cartesian grid topology dimension definition storing information of the dimension with the given index
.
- Parameters
-
index | Dimension index in the range [0,#dimensions-1] |
- Returns
- Requested dimension
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
- Exceptions
-
◆ getId()
IdType pearl::CartTopology::getId |
( |
| ) |
const |
Returns the global identifier of the Cartesian grid topology definition.
- Returns
- Global identifier
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
◆ getName()
const String& pearl::CartTopology::getName |
( |
| ) |
const |
Returns the string definition storing the topology name. If this information is not available, String::UNDEFINED is returned.
- Returns
- Topology name
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
◆ getRankCoordinates()
const CartCoordList pearl::CartTopology::getRankCoordinates |
( |
uint32_t |
rank | ) |
const |
Returns a (potentially empty) list of Cartesian coordinates assigned to the given rank
.
- Parameters
-
rank | Local rank in associated communicator |
- Returns
- List of assigned coordinates (may be empty)
\n@par Exception safety\n <b class="paramname">Strong guarantee:</b> no effects in case an exception is thrown. <br>\n
- Exceptions
-
◆ numDimensions()
uint8_t pearl::CartTopology::numDimensions |
( |
| ) |
const |
Returns the number of Cartesian grid topology dimensions.
- Returns
- Number of dimensions
\n@par Exception safety\n <b class="paramname">No-throw guarantee:</b> never throws exceptions. <br>\n
◆ operator<<()
std::ostream & operator<< |
( |
std::ostream & |
stream, |
|
|
const CartTopology & |
item |
|
) |
| |
|
related |
Prints the contents of the given Cartesian grid topology definition object item
to an output stream
in a human-readable form.
- Parameters
-
stream | Output stream |
item | Cartesian grid topology definition object |
- Returns
- Output stream
◆ mCommunicator
◆ mCoordinates
The documentation for this class was generated from the following file: