class MeshRefine

class which manages grid generation

Inheritance:

MeshRefine


public members:

MeshRefine()
default constructor -- leaves object in an unusable state
MeshRefine( const Box& a_baseDomain, const Vector <int>& a_refRatios, const Real a_fillRatio , const int a_blockFactor, const int a_bufferSize, const int a_maxSize)
full constructor -- leaves object in usable state
const Box& a_baseDomain
level 0 domain
const Vector <int>& a_refRatios
refinement ratios -- refRatio[0] is btwn levels 0 and 1
const Real a_fillRatio
measure of how efficiently tagged cells will be covered
const int a_blockFactor
amount by which grids are guaranteed to be coarsenable
const int a_bufferSize
proper nesting buffer amount
const int a_maxSize
maximum grid length in any direction -- 0 means no limit.
MeshRefine( const ProblemDomain & a_baseDomain, const Vector <int>& a_refRatios, const Real a_fillRatio , const int a_blockFactor, const int a_bufferSize, const int a_maxSize)
full constructor -- leaves object in usable state
const ProblemDomain & a_baseDomain
level 0 domain
const Vector <int>& a_refRatios
refinement ratios -- refRatio[0] is btwn levels 0 and 1
const Real a_fillRatio
measure of how efficiently tagged cells will be covered
const int a_blockFactor
amount by which grids are guaranteed to be coarsenable
const int a_bufferSize
proper nesting buffer amount
const int a_maxSize
maximum grid length in any direction -- 0 means no limit.
virtual ~MeshRefine()
destructor
void define( const Box& a_baseDomain, const Vector <int>& a_refRatios, const Real a_fillRatio , const int a_blockFactor, const int a_bufferSize, const int a_maxSize)
define function -- size of RefRatios will define maximum number of levels
const Box& a_baseDomain
level 0 domain
const Vector <int>& a_refRatios
refinement ratios -- refRatio[0] is btwn levels 0 and 1
const Real a_fillRatio
measure of how efficiently tagged cells will be covered
const int a_blockFactor
amount by which grids are guaranteed to be coarsenable
const int a_bufferSize
proper nesting buffer amount
const int a_maxSize
maximum grid length in any direction -- 0 means no limit
void define( const ProblemDomain & a_baseDomain, const Vector <int>& a_refRatios, const Real a_fillRatio , const int a_blockFactor, const int a_bufferSize, const int a_maxSize)
define function -- size of RefRatios will define maximum number of levels
const ProblemDomain & a_baseDomain
level 0 domain
const Vector <int>& a_refRatios
refinement ratios -- refRatio[0] is btwn levels 0 and 1
const Real a_fillRatio
measure of how efficiently tagged cells will be covered
const int a_blockFactor
amount by which grids are guaranteed to be coarsenable
const int a_bufferSize
proper nesting buffer amount
const int a_maxSize
maximum grid length in any direction -- 0 means no limit
virtual int regrid( Vector < Vector <Box> >& a_newmeshes, const IntVectSet & a_tags, const int a_baseLevel , const int a_topLevel , const Vector < Vector <Box> >& a_oldMeshes) const
create hierarchy of grids from a single level of tags
Vector < Vector <Box> >& a_newmeshes
new set of grids at every level
const IntVectSet & a_tags
tagged cells on baseLevel
const int a_baseLevel
index of base mesh level (finest unchanged level)
const int a_topLevel
top level to refine (one less than finest possible level)
const Vector < Vector <Box> >& a_oldMeshes
existing grids (if no previous grids, set to domains)
virtual int regrid( Vector < Vector <Box> >& a_newmeshes, const Vector < IntVectSet >& a_tags, const int a_baseLevel , const int a_topLevel , const Vector < Vector <Box> >& a_oldMeshes) const
create hierarchy of grids from tags at all levels
Vector < Vector <Box> >& a_newmeshes
new set of grids at every level
const Vector < IntVectSet >& a_tags
tagged cells on each existing level
const int a_baseLevel
index of base mesh level (finest unchanged level)
const int a_topLevel
top level to refine (one less than finest possible level)
const Vector < Vector <Box> >& a_oldMeshes
existing grids (if no previous grids, set to domains)

Access functions
const Vector <int>& refRatios() const
returns vector of refinement ratios
Real fillRatio() const
returns fillRatio
int blockFactor() const
returns blocking factor
int bufferSize() const
returns proper nesting buffer size
int maxSize() const
returns maximum box size in any dimension -- 0 means no limit
void refRatios(const Vector <int>& a_nRefVect)
sets vector of refinement ratios
void fillRatio(const Real a_fill_ratio)
sets fillRatio
void blockFactor(const int a_block_factor)
sets blocking factor
void bufferSize(const int a_buffer_size)
sets proper nesting buffer size
void maxSize(const int a_max_size)
sets maximum box size in any dimension -- 0 means no limit
bool isDefined() const
has this object been defined properly?
virtual void makeBoxes( Vector <Box>& a_mesh, const IntVectSet & a_tags, const IntVectSet & a_pnd , const ProblemDomain & a_domain, const int a_maxSize) const
constructs a set of boxes which covers a set of tagged cells
Vector <Box>& a_mesh
output: refined boxes at each new level
const IntVectSet & a_tags
input: set of tagged cells to cover
const IntVectSet & a_pnd
input: proper nesting domain in which mesh boxes must live
const ProblemDomain & a_domain
input: physical domain
const int a_maxSize
input: largest number of cells in any dimension for any box

protected members:

virtual void computeLocalBlockFactors()
computes local blockFactors used internally to enforce the BlockFactor
virtual void makePNDs( Vector < IntVectSet >& a_pnds, const int a_baseLevel , const int a_topLevel , const Vector < ProblemDomain >& a_domains, const IntVectSet & a_baseMesh, const Vector <int>& a_bufferSize ) const
Computes proper nesting domains. This should only be called by refine. it assumes that everything has already been coarsened by the local blocking factor
Vector < IntVectSet >& a_pnds
output: proper nesting domains at each level
const int a_baseLevel
input: index of highest AMR level not to be refined
const int a_topLevel
input: index of highest AMR level in output
const Vector < ProblemDomain >& a_domains
input: (same as in \funcmeshRefine})
const IntVectSet & a_baseMesh
input: boxes at mesh level \varBaseLevel}
const Vector <int>& a_bufferSize
input: (similar to \funcmeshRefine; but with level-dependent coarsening factors})

Documentation

This class manages grid generation from sets of tagged cells. It is designed to be a pure virtual base class from which another class may be derived with a specific grid-generation algorithm (for example, the BRMeshRefine class).

There are two ways grids can be defined based on tagged cells. one takes a single IntVectSet of tags defined on the BaseLevel mesh and uses that set of tags for every level to be refined; the other takes a Vector<IntVectSet> of tags defined on all the mesh levels to be refined and uses those.

Long Description:

Create new meshes based on tagged cells on a range of levels of a mesh hierarchy. Each level of tagged cells is used to generate a new mesh at the next finer level. The finest level in the output mesh will be one level higher than the top of the range of levels given as input. As a special case, use the same tags (appropriately refined) for all levels.

Usage:

Call the regrid functions after computing error estimates and tagging cells. To add a new mesh level, set TopLevel to the index of the finest level in the existing mesh and define tags on the finest level. To keep the existing number of mesh levels, set TopLevel to one less than the index of the finest level and don't define any tags on the finest level. If a single IntVectSet of tags is passed (instead of a Vector<IntVectSet>) then the same tags (properly refined) will be used for all the new meshes up to level TopLevel+1. In any case, the meshes at levels BaseLevel and below are not modified. The output argument newmeshes will be reallocated to the necessary size before being used. When this function returns, the elements of the newmeshes vector corresponding to the unchanged levels will be filled in with copies of the levels from the old mesh vector. The variable tags is modified in an undefined way, so its contents should not be relied upon. The variable BlockFactor specifies the amount by which each box will be coarsenable. Every grid box will have an integral multiple of BlockFactor cells in each dimension and also lower index values that are integral multiples. As a side effect, the minimum box size will be BlockFactor.

Expensive validations are done only when debugging is enabled (i.e. the DEBUG make variable is "TRUE").

Usage Notes:

All the input vectors should be defined with max index >= TopLevel. They should have values for indices [BaseLevel:TopLevel]. (except for OldMeshes, which must be defined for all indices). The new mesh vector newmeshes will be redefined up to index TopLevel+1. RefRatios should be defined such that RefRatios[L] is the value to use to refine the level L mesh to produce the level L+1 mesh. The tags vector is modified in an undefined manner. The output variable newmeshes may not be completely defined if an exception occurs. The BlockFactor can be used to force a minimum box size.

virtual int regrid ( Vector < Vector <Box> >& a_newmeshes, const IntVectSet & a_tags, const int a_baseLevel , const int a_topLevel , const Vector < Vector <Box> >& a_oldMeshes) const
This function creates a hierarchy of grids from a single level of tags on BaseLevel. If tags exist, then all levels will have grids. Returns the new finest level of grids.

virtual int regrid ( Vector < Vector <Box> >& a_newmeshes, const Vector < IntVectSet >& a_tags, const int a_baseLevel , const int a_topLevel , const Vector < Vector <Box> >& a_oldMeshes) const
This function creates a hierarchy of grids from tags at all refinement levels. It is possible that not all levels will return with grids, since there may not be tags at all levels. Returns the new finest level of grids.

virtual void makeBoxes ( Vector <Box>& a_mesh, const IntVectSet & a_tags, const IntVectSet & a_pnd , const ProblemDomain & a_domain, const int a_maxSize) const
constructs a set of boxes which covers a set of tagged cells by using the algorithm of choice. Everything should be on the same level, and blocking factor is not applied. Boxes will be on the same refinement level as the tags. This would normally be a protected function, but it can be useful to call it on its own, so it has been left public.

virtual void computeLocalBlockFactors ()
This function computes values for m_local_blockfactors array, which is the amount that tags on a level are coarsened in order to guarantee that the grids on the next finer level are coarsenable by the BlockFactor.


this class has no child classes.

alphabetic index hierarchy of classes


Chombo

Copyright Notice

This software is copyright (C) by the Lawrence Berkeley National Laboratory. Permission is granted to reproduce this software for non-commercial purposes provided that this notice is left intact.

It is acknowledged that the U.S. Government has rights to this software under Contract DE-AC03-765F00098 between the U.S. Department of Energy and the University of California.

This software is provided as a professional and academic contribution for joint exchange. Thus it is experimental, is provided ``as is'', with no warranties of any kind whatsoever, no support, no promise of updates, or printed documentation. By using this software, you acknowledge that the Lawrence Berkeley National Laboratory and Regents of the University of California shall have no liability with respect to the infringement of other copyrights by any part of this software.