IBAMR
An adaptive and distributed-memory parallel implementation of the immersed boundary (IB) method
Public Member Functions | Static Public Member Functions | List of all members
IBTK::IBTKInit Class Reference

Initialization for IBAMR programs. More...

#include </home/runner/work/IBAMR/IBAMR/ibtk/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.
 
 IBTKInit (const IBTKInit &from)=delete
 Copy constructor. This function is not implemented and should not be used.
 
IBTKInitoperator= (const IBTKInit &that)=delete
 Assignment operator. This function is not implemented and should not be used.
 
 ~IBTKInit ()
 

Static Public Member Functions

static bool check_initialized ()
 Check if the library has been initialized. Throw an error if it has not been initialized.
 

Detailed Description

Initialization for IBAMR programs.

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()

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()

IBTK::IBTKInit::~IBTKInit ( )

Destructor. Closes libraries appropriately.


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