#include <source/geometry/cartesian/grid_geom/CartesianGridGeometry.h>
Inheritance diagram for SAMRAI::geom::CartesianGridGeometry< DIM >:
Public Member Functions | |
CartesianGridGeometry (const string &object_name, tbox::Pointer< tbox::Database > input_db, bool register_for_restart=true) | |
CartesianGridGeometry (const string &object_name, const double *x_lo, const double *x_up, const hier::BoxArray< DIM > &domain, bool register_for_restart=true) | |
virtual | ~CartesianGridGeometry () |
tbox::Pointer< hier::GridGeometry< DIM > > | makeRefinedGridGeometry (const string &fine_geom_name, const hier::IntVector< DIM > &refine_ratio, bool register_for_restart) const |
tbox::Pointer< hier::GridGeometry< DIM > > | makeCoarsenedGridGeometry (const string &coarse_geom_name, const hier::IntVector< DIM > &coarsen_ratio, bool register_for_restart) const |
void | setGeometryDataOnPatch (hier::Patch< DIM > &patch, const hier::IntVector< DIM > &ratio_to_level_zero, const tbox::Array< tbox::Array< bool > > &touches_regular_bdry, const tbox::Array< tbox::Array< bool > > &touches_periodic_bdry) const |
void | setGeometryData (const double *x_lo, const double *x_up, const hier::BoxArray< DIM > &domain) |
const double * | getDx () const |
const double * | getXLower () const |
const double * | getXUpper () const |
void | printClassData (ostream &os) const |
virtual void | putToDatabase (tbox::Pointer< tbox::Database > db) |
An object of this class requires numerous parameters to be read from input. Also, data must be written to and read from files for restart. The input and restart data are summarized as follows:
Required input keys and data types:
Optional input keys, data types, and defaults:
No input values can overwrite restart values.
A sample input file for a two-dimensional problem might look like:
* * domain_boxes = [(0,0) , (49,39)] * x_lo = 0.0 , 0.0 * x_up = 50.0 , 40.0 * periodic_dimension = 0, 1 // periodic in y only * *
This generates a two-dimensional rectangular domain periodic in the y-direction, and having 50 cells in the x-direction and 40 cells in the y-direction, with the cell size 1 unit in each direction.
|
Constructor for CartesianGridGeometry<DIM> initializes data members based on parameters read from the specified input database or from the restart database corresponding to the specified object name. The constructor also registers this object for restart using the specified object name when the boolean argument is true. Whether object will write its state to restart files during program execution is determined by this argument. Note that it has a default state of true. Errors: passing in a null database pointer or an empty string will result in an unrecoverable assertion. |
|
Constructor for CartesianGridGeometry<DIM> sets data members based on arguments. The constructor also registers this object for restart using the specified object name when the boolean argument is true. Whether object will write its state to restart files during program execution is determined by this argument. Note that it has a default state of true. Errors: passing in an empty string, or null data pointers will result in an unrecoverable assertion. |
|
Destructor for CartesianGridGeometry<DIM> deallocates data describing grid geometry and unregisters the object with the restart manager if previously registered. |
|
Create and return a pointer to a refined version of this Cartesian grid geometry object. This function is pure virtual in the hier::GridGeometry<DIM> base class. Implements SAMRAI::hier::GridGeometry< DIM >. |
|
Create and return a pointer to a coarsened version of this Cartesian grid geometry object. This function is pure virtual in the hier::GridGeometry<DIM> base class. Implements SAMRAI::hier::GridGeometry< DIM >. |
|
Implements SAMRAI::hier::GridGeometry< DIM >. |
|
Set data members for this CartesianGridGeometry<DIM> object. |
|
Return const pointer to dx array for reference level in hierarchy. |
|
Return const pointer to lower spatial coordinate for reference level in hierarchy. |
|
Return const pointer to upper spatial coordinate for reference level in hierarchy. |
|
Print class data representation. Reimplemented from SAMRAI::xfer::Geometry< DIM >. |
|
Writes the state of the CartesianGridGeometry object to the database. When assertion checking is active, db cannot be a null database pointer. |