Multi-CPU information for parallel MOAB. More...

#include <ProcConfig.hpp>

Collaboration diagram for moab::ProcConfig:

Public Member Functions
	ProcConfig (MPI_Comm proc_comm)
	Constructor.
	~ProcConfig ()
unsigned	proc_rank () const
	Get the current processor number.
unsigned	proc_size () const
	Get the number of processors.
gs_data::crystal_data *	crystal_router (bool construct_if_missing=true)
	get a crystal router for this parallel job
MPI_Comm	proc_comm () const
	get/set the communicator for this proc config
void	proc_comm (MPI_Comm this_comm)
void	proc_rank (unsigned r)
	set rank/size; USED FOR TESTING ONLY!
void	proc_size (unsigned s)
Private Attributes
MPI_Comm	procComm
	MPI communicator set for this instance.
unsigned	procRank
	rank of this processor
unsigned	procSize
	number of processors
gs_data::crystal_data *	crystalData
	crystal router for this parallel job

Detailed Description

Multi-CPU information for parallel MOAB.

Examples:: CrystalRouterExample.cpp.

Definition at line 31 of file ProcConfig.hpp.

Constructor & Destructor Documentation

moab::ProcConfig::ProcConfig ( MPI_Comm proc_comm )

Constructor.

Definition at line 23 of file ProcConfig.cpp.

References procComm, procRank, procSize, and size.

                                            : procComm( proc_comm1 ), crystalData( 0 )
{
#ifdef MOAB_HAVE_MPI
    int rank, size;
    MPI_Comm_rank( procComm, &rank );
    procRank = (unsigned int)rank;
    MPI_Comm_size( procComm, &size );
    procSize = (unsigned int)size;
#else
    procRank = 0;
    procSize = 1;
#endif
}

moab::ProcConfig::~ProcConfig ( )

Definition at line 49 of file ProcConfig.cpp.

References crystalData.

{
    if( crystalData )
    {
#ifdef MOAB_HAVE_MPI
        crystalData->reset();
#endif
        delete crystalData;
        crystalData = 0;
    }
}

Member Function Documentation

gs_data::crystal_data * moab::ProcConfig::crystal_router ( bool construct_if_missing = true )

get a crystal router for this parallel job

Examples:: CrystalRouterExample.cpp.

Definition at line 37 of file ProcConfig.cpp.

References crystalData, and procComm.

Referenced by moab::ParallelComm::augment_default_sets_with_ghosts(), moab::ParCommGraph::compute_partition(), moab::ParallelComm::delete_entities(), iMOAB_SetDoubleTagStorageWithGid(), moab::DataCoupler::interpolate(), moab::Coupler::interpolate(), moab::Coupler::locate_points(), main(), moab::ParallelComm::resolve_shared_ents(), and moab::ParallelComm::resolve_shared_sets().

{
#ifdef MOAB_HAVE_MPI
    if( !crystalData && construct_if_missing )
    {
        crystalData = new gs_data::crystal_data( procComm );
    }
#endif

    return crystalData;
}

MPI_Comm moab::ProcConfig::proc_comm ( ) const [inline]

get/set the communicator for this proc config

Examples:: HelloParMOAB.cpp.

Definition at line 54 of file ProcConfig.hpp.

References procComm.

    {
        return procComm;
    }

void moab::ProcConfig::proc_comm ( MPI_Comm this_comm ) [inline]

Definition at line 58 of file ProcConfig.hpp.

References procComm.

    {
        procComm = this_comm;
    }

unsigned moab::ProcConfig::proc_rank ( ) const [inline]

Get the current processor number.

Examples:: CrystalRouterExample.cpp, HelloParMOAB.cpp, and ReadWriteTest.cpp.

Definition at line 39 of file ProcConfig.hpp.

References procRank.

    {
        return procRank;
    }

void moab::ProcConfig::proc_rank ( unsigned r ) [inline]

set rank/size; USED FOR TESTING ONLY!

Definition at line 64 of file ProcConfig.hpp.

References procRank.

    {
        procRank = r;
    }

unsigned moab::ProcConfig::proc_size ( ) const [inline]

Get the number of processors.

Examples:: CrystalRouterExample.cpp, HelloParMOAB.cpp, and ReadWriteTest.cpp.

Definition at line 45 of file ProcConfig.hpp.

References procSize.

Referenced by moab::MeshOutputFunctor::assign_global_ids(), moab::ParallelComm::assign_global_ids(), moab::ParallelComm::augment_default_sets_with_ghosts(), moab::NCWriteGCRM::collect_mesh_info(), moab::NCWriteHOMME::collect_mesh_info(), moab::NCWriteMPAS::collect_mesh_info(), moab::ScdNCWriteHelper::collect_mesh_info(), moab::WriteHDF5Parallel::create_dataset(), moab::NCHelperScrip::create_mesh(), moab::NCHelperHOMME::create_mesh(), moab::NCHelperGCRM::create_mesh(), moab::NCHelperMPAS::create_mesh(), moab::ReadParallel::delete_nonlocal_entities(), moab::ParallelComm::gather_data(), moab::ScdInterface::get_shared_vertices(), moab::NCHelperFV::init_mesh_vals(), moab::NCHelperDomain::init_mesh_vals(), moab::NCHelperEuler::init_mesh_vals(), moab::Coupler::initialize_tree(), moab::ReadParallel::load_file(), moab::Coupler::locate_points(), main(), moab::WriteHDF5Parallel::negotiate_type_list(), moab::ParallelComm::scatter_entities(), moab::ParallelComm::set_rank(), moab::ParallelComm::set_size(), and moab::ParallelComm::size().

    {
        return procSize;
    }

void moab::ProcConfig::proc_size ( unsigned s ) [inline]

Definition at line 68 of file ProcConfig.hpp.

References procSize.

    {
        procSize = s;
    }

Member Data Documentation

gs_data::crystal_data* moab::ProcConfig::crystalData [private]

crystal router for this parallel job

Definition at line 84 of file ProcConfig.hpp.

Referenced by crystal_router(), and ~ProcConfig().

MPI_Comm moab::ProcConfig::procComm [private]

MPI communicator set for this instance.

Definition at line 75 of file ProcConfig.hpp.

Referenced by crystal_router(), proc_comm(), and ProcConfig().

unsigned moab::ProcConfig::procRank [private]

rank of this processor

Definition at line 78 of file ProcConfig.hpp.

Referenced by proc_rank(), and ProcConfig().

unsigned moab::ProcConfig::procSize [private]

number of processors

Definition at line 81 of file ProcConfig.hpp.

Referenced by proc_size(), and ProcConfig().

List of all members.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation