libMesh::LibMeshInit Class Reference

#include <libmesh.h>

Public Member Functions

 LibMeshInit (int argc, const char *const *argv, MPI_Comm COMM_WORLD_IN=MPI_COMM_WORLD)
 
 LibMeshInit (int argc, const char *const *argv)
 
virtual ~LibMeshInit ()
 
const Parallel::Communicatorcomm () const
 

Private Attributes

Parallel::Communicator _comm
 

Detailed Description

The LibMeshInit class, when constructed, initializes the dependent libraries (e.g. MPI or PETSC) and does the command line parsing needed by libMesh. The LibMeshInit destructor closes those libraries properly.

For most users, a single LibMeshInit object should be created at the start of your main() function. This object replaces the previous libMesh::init()/libMesh::close() methods, which are now deprecated.

Definition at line 57 of file libmesh.h.

Constructor & Destructor Documentation

libMesh::LibMeshInit::LibMeshInit ( int  argc,
const char *const *  argv,
MPI_Comm  COMM_WORLD_IN = MPI_COMM_WORLD 
)

Initialize the library for use, with the command line options provided. This will e.g. call PetscInitialize if PETSC is available. You must create a LibMeshInit object before using any of the library functionality. This method may take an optional parameter to use a user-specified MPI communicator.

libMesh::LibMeshInit::LibMeshInit ( int  argc,
const char *const *  argv 
)
virtual libMesh::LibMeshInit::~LibMeshInit ( )
virtual

Member Function Documentation

const Parallel::Communicator& libMesh::LibMeshInit::comm ( ) const
inline

Definition at line 76 of file libmesh.h.

References _comm.

76 { return _comm; }

Member Data Documentation

Parallel::Communicator libMesh::LibMeshInit::_comm
private

Definition at line 79 of file libmesh.h.

Referenced by comm().


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

Site Created By: libMesh Developers
Last modified: February 07 2014 16:57:26 UTC

Hosted By:
SourceForge.net Logo