Class AppInitializer provides functionality to simplify the initialization code in an application code. More...
#include </home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/AppInitializer.h>
Detailed Description
Class AppInitializer provides functionality to simplify the initialization code in an application code.
Constructor & Destructor Documentation
◆ AppInitializer()
| 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 |
Destructor for class AppInitializer frees the SAMRAI manager objects used to set up input and restart databases.
Member Function Documentation
◆ dumpPostProcessingData()
| bool IBTK::AppInitializer::dumpPostProcessingData | ( | ) | const |
Return a boolean value indicating whether to write post processing data.
◆ dumpRestartData()
| bool IBTK::AppInitializer::dumpRestartData | ( | ) | const |
Return a boolean value indicating whether to write restart data.
◆ dumpTimerData()
| bool IBTK::AppInitializer::dumpTimerData | ( | ) | const |
Return a boolean value indicating whether to write timer data.
◆ dumpVizData()
| bool IBTK::AppInitializer::dumpVizData | ( | ) | const |
Return a boolean value indicating whether to write visualization data.
◆ getComponentDatabase()
| Pointer< 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.
◆ 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.
◆ getInputDatabase()
Return a pointer to the input database.
◆ getLSiloDataWriter()
| 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.
◆ getPostProcessingDataDumpDirectory()
| std::string IBTK::AppInitializer::getPostProcessingDataDumpDirectory | ( | ) | const |
Return the post processing data dump directory name.
◆ getPostProcessingDataDumpInterval()
| int IBTK::AppInitializer::getPostProcessingDataDumpInterval | ( | ) | const |
Return the post processing data dump interval.
◆ getRestartDatabase()
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.
◆ 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.
◆ 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.
◆ 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.
◆ getTimerDumpInterval()
| int IBTK::AppInitializer::getTimerDumpInterval | ( | ) | const |
Return the timer dump interval.
◆ getVisItDataWriter()
| Pointer< 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.
◆ getVizDumpDirectory()
| std::string IBTK::AppInitializer::getVizDumpDirectory | ( | ) | const |
Return the visualization dump directory name.
◆ getVizDumpInterval()
| int IBTK::AppInitializer::getVizDumpInterval | ( | ) | const |
Return the visualization dump interval.
◆ getVizWriters()
| std::vector< std::string > IBTK::AppInitializer::getVizWriters | ( | ) | const |
Return the visualization writers to be used in the simulation.
◆ 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.
The documentation for this class was generated from the following files:
- /home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/AppInitializer.h
- /home/runner/work/IBAMR/IBAMR/ibtk/src/utilities/AppInitializer.cpp
