Class AppInitializer provides functionality to simplify the initialization code in an application code. More...

#include <ibtk/AppInitializer.h>

Inheritance diagram for IBTK::AppInitializer:

Public Member Functions
	AppInitializer (int argc, char *argv[], const std::string &default_log_file_name="IBAMR.log")

virtual	~AppInitializer ()

SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	getInputDatabase ()

bool	isFromRestart () const

const std::string &	getRestartReadDirectory () const

int	getRestartRestoreNumber () const

SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	getRestartDatabase (bool suppress_warning=false)

SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	getComponentDatabase (const std::string &component_name, bool suppress_warning=false)

bool	dumpVizData () const

int	getVizDumpInterval () const

std::string	getVizDumpDirectory () const

std::vector< std::string >	getVizWriters () const

SAMRAI::tbox::Pointer< SAMRAI::appu::VisItDataWriter< NDIM > >	getVisItDataWriter () const

SAMRAI::tbox::Pointer< LSiloDataWriter >	getLSiloDataWriter () const

std::string	getExodusIIFilename (const std::string &prefix="") const

std::string	getGMVFilename (const std::string &prefix="") const

bool	dumpRestartData () const

int	getRestartDumpInterval () const

std::string	getRestartDumpDirectory () const

bool	dumpPostProcessingData () const

int	getPostProcessingDataDumpInterval () const

std::string	getPostProcessingDataDumpDirectory () const

bool	dumpTimerData () const

int	getTimerDumpInterval () const

Private Member Functions
	AppInitializer (const AppInitializer &from)=delete
	Copy constructor. More...

AppInitializer &	operator= (const AppInitializer &that)=delete
	Assignment operator. More...

Private Attributes
SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	d_input_db

std::string	d_restart_read_dirname

int	d_restart_restore_num = 0

bool	d_is_from_restart = false

int	d_viz_dump_interval = 0

std::string	d_viz_dump_dirname

std::vector< std::string >	d_viz_writers

SAMRAI::tbox::Pointer< SAMRAI::appu::VisItDataWriter< NDIM > >	d_visit_data_writer

SAMRAI::tbox::Pointer< LSiloDataWriter >	d_silo_data_writer

std::string	d_exodus_filename = "output.ex2"

std::string	d_gmv_filename = "output.gmv"

int	d_restart_dump_interval = 0

std::string	d_restart_dump_dirname

int	d_data_dump_interval = 0

std::string	d_data_dump_dirname

int	d_timer_dump_interval = 0

Detailed Description

PETSc options may be supplied by petsc_settings or petsc_settings_<tag> databases placed anywhere in the input file, usually beside the component configuration they support. Their location is only organizational. For example,

Main {
    petsc_settings {
        ksp_type = "fgmres"
        rtol = 1.0e-12
    }
}
PoissonSolver {
    petsc_settings_SP {
        ksp_max_it = 341
        monitor = TRUE
    }
}

The untagged entries produce -ksp_type and -rtol, while the tagged entries produce -SP_ksp_max_it and -SP_monitor: the tag becomes a literal prefix and the enclosing database name does not contribute one. Values may be scalar Boolean, integer, float, double, or string values. Following PETSc conventions, command-line options take precedence over settings in the input file.

As a mutually exclusive alternative to inline settings, the top-level PETSC_OPTIONS_FILE or petsc_options_file key may name an options file; PETSC_OPTIONS_FILE takes precedence when both spellings are present. The file is sought first at the path as written and then relative to the directory containing the input file.

Constructor & Destructor Documentation

◆ AppInitializer() [1/2]

IBTK::AppInitializer::AppInitializer	(	int	argc,
		char *	argv[],
		const std::string &	default_log_file_name = `"IBAMR.log"`
	)

Constructor for class AppInitializer parses command line arguments, sets up input and restart databases, and enables SAMRAI logging.

◆ ~AppInitializer()

virtual IBTK::AppInitializer::~AppInitializer ( )

virtual

Destructor for class AppInitializer frees the SAMRAI manager objects used to set up input and restart databases.

◆ AppInitializer() [2/2]

IBTK::AppInitializer::AppInitializer ( const AppInitializer & from )

privatedelete

Note: This constructor is not implemented and should not be used.

Parameters

from	The value to copy to this object.

Member Function Documentation

◆ getInputDatabase()

SAMRAI::tbox::Pointer<SAMRAI::tbox::Database> IBTK::AppInitializer::getInputDatabase ( )

Return a pointer to the input database.

◆ isFromRestart()

bool IBTK::AppInitializer::isFromRestart ( ) const

Return a boolean value indicating whether this is a restarted run. This is defined as true when the program recognizes command line arguments for restart_restore_num and restart_dump_dirname.

◆ getRestartReadDirectory()

const std::string& IBTK::AppInitializer::getRestartReadDirectory ( ) const

Return the restart directory. If we are not starting from restart, this method returns an empty string. This value is set by the second command line argument to the executable.

◆ getRestartRestoreNumber()

int IBTK::AppInitializer::getRestartRestoreNumber ( ) const

Return the restart restore number. If we are not starting from restart, this method returns 0. This value is set by the third command line argument to the executable.

◆ getRestartDatabase()

SAMRAI::tbox::Pointer<SAMRAI::tbox::Database> IBTK::AppInitializer::getRestartDatabase ( bool suppress_warning = false )

Return a pointer to the restart database. If there is no restart database for the application, this method emits a warning message and returns a NullDatabse.

◆ getComponentDatabase()

SAMRAI::tbox::Pointer<SAMRAI::tbox::Database> IBTK::AppInitializer::getComponentDatabase	(	const std::string &	component_name,
		bool	suppress_warning = `false`
	)

Return initialization database for the requested solver component. This is equivalent to: getInputDatabase()->getDatabase(component_name).

If the requested component is not found in the input database, this method emits a warning message and returns a NullDatabse.

◆ dumpVizData()

bool IBTK::AppInitializer::dumpVizData ( ) const

Return a boolean value indicating whether to write visualization data.

◆ getVizDumpInterval()

int IBTK::AppInitializer::getVizDumpInterval ( ) const

Return the visualization dump interval.

◆ getVizDumpDirectory()

std::string IBTK::AppInitializer::getVizDumpDirectory ( ) const

Return the visualization dump directory name.

◆ getVizWriters()

std::vector<std::string> IBTK::AppInitializer::getVizWriters ( ) const

Return the visualization writers to be used in the simulation.

◆ getVisItDataWriter()

SAMRAI::tbox::Pointer<SAMRAI::appu::VisItDataWriter<NDIM> > IBTK::AppInitializer::getVisItDataWriter ( ) const

Return a VisIt data writer object to be used to output Cartesian grid data.

If the application is not configured to use VisIt, a nullptr pointer will be returned.

◆ getLSiloDataWriter()

SAMRAI::tbox::Pointer<LSiloDataWriter> IBTK::AppInitializer::getLSiloDataWriter ( ) const

Return a VisIt data writer object to be used to output Lagrangian data.

If the application is not configured to use VisIt, a nullptr pointer will be returned.

◆ getExodusIIFilename()

std::string IBTK::AppInitializer::getExodusIIFilename ( const std::string & prefix = "" ) const

Return the ExodusII visualization file name.

If the application is not configured to use ExodusII, an empty string will be returned.

◆ getGMVFilename()

std::string IBTK::AppInitializer::getGMVFilename ( const std::string & prefix = "" ) const

Return the GMV visualization file name.

If the application is not configured to use GMV, an empty string will be returned.

◆ dumpRestartData()

bool IBTK::AppInitializer::dumpRestartData ( ) const

Return a boolean value indicating whether to write restart data.

◆ getRestartDumpInterval()

int IBTK::AppInitializer::getRestartDumpInterval ( ) const

Return the restart dump interval. This is set in the Main database of the input file. This can be defined in the input file as restart_interval, restart_dump_interval, or restart_write_interval.

◆ getRestartDumpDirectory()

std::string IBTK::AppInitializer::getRestartDumpDirectory ( ) const

Return the restart dump directory name. This is set in the Main database of the input file. This can be defined in the input file as restart_dump_dirname, restart_dirname, or restart_write_dirname.

◆ dumpPostProcessingData()

bool IBTK::AppInitializer::dumpPostProcessingData ( ) const

Return a boolean value indicating whether to write post processing data.

◆ getPostProcessingDataDumpInterval()

int IBTK::AppInitializer::getPostProcessingDataDumpInterval ( ) const

Return the post processing data dump interval.

◆ getPostProcessingDataDumpDirectory()

std::string IBTK::AppInitializer::getPostProcessingDataDumpDirectory ( ) const

Return the post processing data dump directory name.

◆ dumpTimerData()

bool IBTK::AppInitializer::dumpTimerData ( ) const

Return a boolean value indicating whether to write timer data.

◆ getTimerDumpInterval()

int IBTK::AppInitializer::getTimerDumpInterval ( ) const

Return the timer dump interval.

◆ operator=()

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

privatedelete

Note: This operator is not implemented and should not be used.

Parameters

that	The value to assign to this object.

Returns: A reference to this object.

Member Data Documentation

◆ d_input_db

SAMRAI::tbox::Pointer<SAMRAI::tbox::Database> IBTK::AppInitializer::d_input_db

private

The input database.

◆ d_restart_read_dirname

std::string IBTK::AppInitializer::d_restart_read_dirname

private

Restart settings.

◆ d_restart_restore_num

int IBTK::AppInitializer::d_restart_restore_num = 0

private

◆ d_is_from_restart

bool IBTK::AppInitializer::d_is_from_restart = false

private

◆ d_viz_dump_interval

int IBTK::AppInitializer::d_viz_dump_interval = 0

private

Visualization options.

◆ d_viz_dump_dirname

std::string IBTK::AppInitializer::d_viz_dump_dirname

private

◆ d_viz_writers

std::vector<std::string> IBTK::AppInitializer::d_viz_writers

private

◆ d_visit_data_writer

SAMRAI::tbox::Pointer<SAMRAI::appu::VisItDataWriter<NDIM> > IBTK::AppInitializer::d_visit_data_writer

private

◆ d_silo_data_writer

SAMRAI::tbox::Pointer<LSiloDataWriter> IBTK::AppInitializer::d_silo_data_writer

private

◆ d_exodus_filename

std::string IBTK::AppInitializer::d_exodus_filename = "output.ex2"

private

◆ d_gmv_filename

std::string IBTK::AppInitializer::d_gmv_filename = "output.gmv"

private

◆ d_restart_dump_interval

int IBTK::AppInitializer::d_restart_dump_interval = 0

private

Restart options.

◆ d_restart_dump_dirname

std::string IBTK::AppInitializer::d_restart_dump_dirname

private

◆ d_data_dump_interval

int IBTK::AppInitializer::d_data_dump_interval = 0

private

Post-processing options.

◆ d_data_dump_dirname

std::string IBTK::AppInitializer::d_data_dump_dirname

private

◆ d_timer_dump_interval

int IBTK::AppInitializer::d_timer_dump_interval = 0

private

Timer options.

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

ibtk/include/ibtk/AppInitializer.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AppInitializer() [1/2]

◆ ~AppInitializer()

◆ AppInitializer() [2/2]

Member Function Documentation

◆ getInputDatabase()

◆ isFromRestart()

◆ getRestartReadDirectory()

◆ getRestartRestoreNumber()

◆ getRestartDatabase()

◆ getComponentDatabase()

◆ dumpVizData()

◆ getVizDumpInterval()

◆ getVizDumpDirectory()

◆ getVizWriters()

◆ getVisItDataWriter()

◆ getLSiloDataWriter()

◆ getExodusIIFilename()

◆ getGMVFilename()

◆ dumpRestartData()

◆ getRestartDumpInterval()

◆ getRestartDumpDirectory()

◆ dumpPostProcessingData()

◆ getPostProcessingDataDumpInterval()

◆ getPostProcessingDataDumpDirectory()

◆ dumpTimerData()

◆ getTimerDumpInterval()

◆ operator=()

Member Data Documentation

◆ d_input_db

◆ d_restart_read_dirname

◆ d_restart_restore_num

◆ d_is_from_restart

◆ d_viz_dump_interval

◆ d_viz_dump_dirname

◆ d_viz_writers

◆ d_visit_data_writer

◆ d_silo_data_writer

◆ d_exodus_filename

◆ d_gmv_filename

◆ d_restart_dump_interval

◆ d_restart_dump_dirname

◆ d_data_dump_interval

◆ d_data_dump_dirname

◆ d_timer_dump_interval