Cyclops Tensor Framework
parallel arithmetic on multidimensional arrays
CTF::World Class Reference

an instance of the CTF library (world) on a MPI communicator More...

#include <world.h>

Inheritance diagram for CTF::World:
Collaboration diagram for CTF::World:

Public Member Functions

 World (int argc, char *const *argv)
 creates CTF library on comm that can output profile data into a file with a name based on the main args More...
 
 World (World const &other)
 copy constructor, reallocates copies of all topologies More...
 
 World (MPI_Comm comm=MPI_COMM_WORLD, int argc=0, char *const *argv=NULL)
 creates CTF library on comm that can output profile data into a file with a name based on the main args More...
 
 World (int order, int const *lens, MPI_Comm comm=MPI_COMM_WORLD, int argc=0, char *const *argv=NULL)
 creates CTF library on comm More...
 
 World (char const *emptystring)
 substitute for default constructor that does not initialize the world More...
 
 ~World ()
 frees CTF library More...
 
bool operator== (World const &other)
 

Data Fields

MPI_Comm comm
 set of processors making up this world More...
 
int rank
 rank of local processor More...
 
int np
 number of processors More...
 
std::vector< CTF_int::topology * > topovec
 derived topologies More...
 
bool initialized
 whether the world has been initialized More...
 
CTF_int::CommData cdt
 communicator data for MPI comm defining this world More...
 
CTF_int::topologyphys_topology
 main torus topology corresponding to the world More...
 
std::mersenne_twister_engine< std::uint_fast64_t, 64, 312, 156, 31, 0xb5026f5aa96619e9, 29, 0x5555555555555555, 17, 0x71d67fffeda60000, 37, 0xfff7eee000000000, 43, 6364136223846793005 > glob_wrld_rng
 random number generator for this world object (same seed for each rank) More...
 
bool is_copy
 

Detailed Description

an instance of the CTF library (world) on a MPI communicator

Definition at line 19 of file world.h.

Constructor & Destructor Documentation

CTF::World::World ( int  argc,
char *const *  argv 
)

creates CTF library on comm that can output profile data into a file with a name based on the main args

Parameters
[in]argcnumber of main arguments
[in]argvmain arguments

Definition at line 34 of file world.cxx.

References CTF::comm, CTF_int::TOPOLOGY_BGP, CTF_int::TOPOLOGY_BGQ, and CTF_int::TOPOLOGY_GENERIC.

CTF::World::World ( World const &  other)

copy constructor, reallocates copies of all topologies

Parameters
[in]otherworld to copy

Definition at line 74 of file world.cxx.

References CTF::comm, comm, CTF_int::topology::lens, CTF_int::topology::order, phys_topology, and rank.

CTF::World::World ( MPI_Comm  comm = MPI_COMM_WORLD,
int  argc = 0,
char *const *  argv = NULL 
)

creates CTF library on comm that can output profile data into a file with a name based on the main args

Parameters
[in]commMPI communicator associated with this CTF instance
[in]argcnumber of main arguments
[in]argvmain arguments

Definition at line 49 of file world.cxx.

References CTF::comm, CTF_int::TOPOLOGY_BGP, CTF_int::TOPOLOGY_BGQ, and CTF_int::TOPOLOGY_GENERIC.

CTF::World::World ( int  order,
int const *  lens,
MPI_Comm  comm = MPI_COMM_WORLD,
int  argc = 0,
char *const *  argv = NULL 
)

creates CTF library on comm

Parameters
[in]ordernumber of torus network dimensions
[in]lenslengths of torus network dimensions
[in]commMPI global context for this CTF World
[in]argcnumber of main arguments
[in]argvmain arguments

Definition at line 65 of file world.cxx.

References CTF::comm.

CTF::World::World ( char const *  emptystring)

substitute for default constructor that does not initialize the world

Parameters
[in]emptystringshould be set to ""

Definition at line 94 of file world.cxx.

Member Function Documentation

bool CTF::World::operator== ( World const &  other)
inline

Definition at line 96 of file world.h.

References comm.

Field Documentation

std::mersenne_twister_engine<std::uint_fast64_t, 64, 312, 156, 31, 0xb5026f5aa96619e9, 29, 0x5555555555555555, 17, 0x71d67fffeda60000, 37, 0xfff7eee000000000, 43, 6364136223846793005> CTF::World::glob_wrld_rng

random number generator for this world object (same seed for each rank)

Definition at line 40 of file world.h.

bool CTF::World::initialized

whether the world has been initialized

Definition at line 30 of file world.h.

bool CTF::World::is_copy

Definition at line 97 of file world.h.

Referenced by CTF::get_universe().

CTF_int::topology* CTF::World::phys_topology

main torus topology corresponding to the world

Definition at line 34 of file world.h.

Referenced by World().

std::vector< CTF_int::topology* > CTF::World::topovec

derived topologies

Definition at line 28 of file world.h.

Referenced by CTF_int::scaling::execute(), CTF_int::get_len_ordering(), and CTF_int::summation::is_equal().


The documentation for this class was generated from the following files: