libMesh::LibMeshInit Class Reference

#include <libmesh.h>

List of all members.

Public Member Functions

 LibMeshInit (int &argc, char **&argv, MPI_Comm COMM_WORLD_IN=MPI_COMM_WORLD)
 LibMeshInit (int &argc, char **&argv)
virtual ~LibMeshInit ()

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()/libMeshclose() methods, which are now deprecated.

Definition at line 56 of file libmesh.h.


Constructor & Destructor Documentation

libMesh::LibMeshInit::LibMeshInit ( int &  argc,
char **&  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,
char **&  argv 
)
virtual libMesh::LibMeshInit::~LibMeshInit (  )  [virtual]

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

Site Created By: libMesh Developers
Last modified: February 05 2013 19:55:28 UTC

Hosted By:
SourceForge.net Logo