IBTK::IBTKInit Class Reference

Initialization for IBAMR programs. More...

#include <ibtk/IBTKInit.h>

Public Member Functions
	IBTKInit (int argc, char **argv, MPI_Comm communicator=MPI_COMM_WORLD, char *petsc_file=nullptr, char *petsc_help=nullptr)
	IBTKInit ()=delete
	Default constructor. This function is not implemented and should not be used. More...
	IBTKInit (const IBTKInit &from)=delete
	Copy constructor. This function is not implemented and should not be used. More...
IBTKInit &	operator= (const IBTKInit &that)=delete
	Assignment operator. This function is not implemented and should not be used. More...
	~IBTKInit ()
libMesh::LibMeshInit &	getLibMeshInit ()

Static Public Member Functions
static bool	check_initialized ()
	Check if the library has been initialized. Throw an error if it has not been initialized. More...

Private Attributes
libMesh::LibMeshInit	d_libmesh_init

Static Private Attributes
static bool	s_initialized

Detailed Description

The singleton IBTKInit class handles the initializations for PETSc, LibMesh, and SAMRAI. This object should be created using the initialize() function at the start of the main() function. The destruction of the object correctly closes the libraries.

Constructor & Destructor Documentation

IBTKInit() [1/3]

IBTK::IBTKInit::IBTKInit	(	int	argc,
		char **	argv,
		MPI_Comm	communicator = MPI_COMM_WORLD,
		char *	petsc_file = nullptr,
		char *	petsc_help = nullptr
	)

Constructor for IBTKInit. Initializes libraries and sets the SAMRAI world communicator. Attempts to create a second IBTKInit object will result in a run time error.

IBTKInit() [2/3]

IBTK::IBTKInit::IBTKInit ( )

delete

IBTKInit() [3/3]

IBTK::IBTKInit::IBTKInit ( const IBTKInit &  from )

delete

~IBTKInit()

IBTK::IBTKInit::~IBTKInit

(

)

Destructor. Closes libraries appropriately.

Member Function Documentation

operator=()

IBTKInit& IBTK::IBTKInit::operator= ( const IBTKInit &  that )

delete

getLibMeshInit()

libMesh::LibMeshInit& IBTK::IBTKInit::getLibMeshInit ( )

inline

Get libMesh initialization object.

check_initialized()

static bool IBTK::IBTKInit::check_initialized ( )

inlinestatic

Member Data Documentation

d_libmesh_init

libMesh::LibMeshInit IBTK::IBTKInit::d_libmesh_init

private

s_initialized

bool IBTK::IBTKInit::s_initialized

staticprivate

---

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

• ibtk/include/ibtk/IBTKInit.h