Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys > Class Template Reference

A thin wrapper that implements Portage-relevant methods for Adaptive_Refinement_Mesh. More...

#include <adaptive_refinement_mesh_wrapper.h>

Public Member Functions

 Adaptive_Refinement_Mesh_Wrapper ()=delete
 Default constructor (disabled) More...
 
 Adaptive_Refinement_Mesh_Wrapper (Adaptive_Refinement_Mesh< D, CoordSys > const &mesh)
 Constructor for the mesh wrapper. More...
 
 Adaptive_Refinement_Mesh_Wrapper (Adaptive_Refinement_Mesh_Wrapper< D, CoordSys > const &)=delete
 Copy constructor (disabled). More...
 
Adaptive_Refinement_Mesh_Wrapperoperator= (Adaptive_Refinement_Mesh_Wrapper< D, CoordSys > const &)=delete
 Assignment operator (disabled). More...
 
int space_dimension () const
 Get dimensionality of the mesh. More...
 
int num_owned_cells () const
 Get number of cells owned by this processing element. More...
 
int num_ghost_cells () const
 Get number of ghost cells on this processing element. More...
 
void cell_get_bounds (const int id, Point< D > *plo, Point< D > *phi) const
 Get lower and upper corners of cell bounding box. More...
 
counting_iterator begin (Entity_kind const entity, Entity_type const etype=Entity_type::ALL) const
 Iterators on mesh entity - begin. More...
 
counting_iterator end (Entity_kind const entity, Entity_type const etype=Entity_type::ALL) const
 Iterator on mesh entity - end. More...
 

Detailed Description

template<int D, class CoordSys = DefaultCoordSys>
class Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >

A thin wrapper that implements Portage-relevant methods for Adaptive_Refinement_Mesh.

The methods implemented are those required by select parts of the Wonton and Portage code. This will expand as the list of components that this wrapper supports expands.

Constructor & Destructor Documentation

◆ Adaptive_Refinement_Mesh_Wrapper() [1/3]

template<int D, class CoordSys = DefaultCoordSys>
Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >::Adaptive_Refinement_Mesh_Wrapper ( )
delete

Default constructor (disabled)

◆ Adaptive_Refinement_Mesh_Wrapper() [2/3]

template<int D, class CoordSys >
Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >::Adaptive_Refinement_Mesh_Wrapper ( Adaptive_Refinement_Mesh< D, CoordSys > const &  mesh)
explicit

Constructor for the mesh wrapper.

Parameters
[in]meshThe Adaptive_Refinement_Mesh we wish to wrap.

◆ Adaptive_Refinement_Mesh_Wrapper() [3/3]

template<int D, class CoordSys = DefaultCoordSys>
Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >::Adaptive_Refinement_Mesh_Wrapper ( Adaptive_Refinement_Mesh_Wrapper< D, CoordSys > const &  )
delete

Copy constructor (disabled).

Member Function Documentation

◆ begin()

template<int D, class CoordSys >
counting_iterator Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >::begin ( Entity_kind const  entity,
Entity_type const  etype = Entity_type::ALL 
) const

Iterators on mesh entity - begin.

◆ cell_get_bounds()

template<int D, class CoordSys >
void Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >::cell_get_bounds ( const int  id,
Point< D > *  plo,
Point< D > *  phi 
) const

Get lower and upper corners of cell bounding box.

◆ end()

template<int D, class CoordSys >
counting_iterator Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >::end ( Entity_kind const  entity,
Entity_type const  etype = Entity_type::ALL 
) const

Iterator on mesh entity - end.

◆ num_ghost_cells()

template<int D, class CoordSys >
int Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >::num_ghost_cells ( ) const

Get number of ghost cells on this processing element.

◆ num_owned_cells()

template<int D, class CoordSys >
int Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >::num_owned_cells ( ) const

Get number of cells owned by this processing element.

◆ operator=()

template<int D, class CoordSys = DefaultCoordSys>
Adaptive_Refinement_Mesh_Wrapper& Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >::operator= ( Adaptive_Refinement_Mesh_Wrapper< D, CoordSys > const &  )
delete

Assignment operator (disabled).

◆ space_dimension()

template<int D, class CoordSys >
int Wonton::Adaptive_Refinement_Mesh_Wrapper< D, CoordSys >::space_dimension ( ) const

Get dimensionality of the mesh.


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