Dune::GridFactory< ALUSimplexGrid< 3, 3 > > Class Template Reference
[GridFactory]

Specialization of the generic GridFactory for ALUSimplexGrid<3,3> More...

#include <dune/grid/alugrid/3d/alu3dgridfactory.hh>

Inheritance diagram for Dune::GridFactory< ALUSimplexGrid< 3, 3 > >:
Inheritance graph

List of all members.

Public Types

typedef BaseType::Grid Grid
typedef
BaseType::MPICommunicatorType 
MPICommunicatorType
typedef Grid::ctype ctype
 Type used by the grid for coordinates.
typedef DuneBoundaryProjection< 3 > DuneBoundaryProjectionType
 type of boundary projection class
typedef ALUGridTransformation
< ctype, dimensionworld
Transformation
typedef Transformation::WorldVector WorldVector
 type of vector for world coordinates
typedef Transformation::WorldMatrix WorldMatrix
 type of matrix from world coordinates to world coordinates

Public Member Functions

 GridFactory (const MPICommunicatorType &communicator=Grid::defaultCommunicator())
 Default constructor.
 GridFactory (const std::string &filename, const MPICommunicatorType &communicator=Grid::defaultCommunicator())
 constructor taking filename
virtual void insertVertex (const VertexType &pos)
 insert a vertex into the coarse grid
virtual void insertVertex (const FieldVector< ctype, dimworld > &pos)=0
 Insert a vertex into the coarse grid.
virtual void insertElement (const GeometryType &geometry, const std::vector< unsigned int > &vertices)
 insert an element into the coarse grid
virtual void insertElement (const GeometryType &type, const std::vector< unsigned int > &vertices, const shared_ptr< VirtualFunction< FieldVector< ctype, dimension >, FieldVector< ctype, dimworld > > > &elementParametrization)
 Insert a parametrized element into the coarse grid.
virtual void insertBoundary (const GeometryType &geometry, const std::vector< unsigned int > &faceVertices, const int id)
 insert a boundary element into the coarse grid
virtual void insertBoundary (const int element, const int face, const int id)
 mark a face as boundary (and assign a boundary id)
virtual void insertBoundaryProjection (const GeometryType &type, const std::vector< unsigned int > &vertices, const DuneBoundaryProjectionType *projection)
 insert a boundary projection into the macro grid
virtual void insertBoundaryProjection (const DuneBoundaryProjectionType &bndProjection)
 insert a boundary projection object, (a copy is made)
virtual void insertBoundarySegment (const std::vector< unsigned int > &vertices)
 insert a boundary segment into the macro grid
virtual void insertBoundarySegment (const std::vector< unsigned int > &vertices, const shared_ptr< BoundarySegment< 3, 3 > > &boundarySegment)
 insert a shaped boundary segment into the macro grid
virtual void insertBoundarySegment (const std::vector< unsigned int > &vertices, const shared_ptr< BoundarySegment< dimension, dimworld > > &boundarySegment)
 insert an arbitrarily shaped boundary segment
void insertFaceTransformation (const WorldMatrix &matrix, const WorldVector &shift)
 add a face transformation (for periodic identification)
GridcreateGrid ()
 finalize the grid creation and hand over the grid
GridcreateGrid (const bool addMissingBoundaries, const std::string dgfName="")
GridcreateGrid (const bool addMissingBoundaries, bool temporary, const std::string dgfName="")
virtual unsigned int insertionIndex (const typename Codim< 0 >::Entity &entity) const
 obtain an element's insertion index
virtual unsigned int insertionIndex (const typename Codim< dimension >::Entity &entity) const
 obtain a vertex' insertion index
virtual unsigned int insertionIndex (const typename Grid::LeafIntersection &intersection) const
virtual unsigned int insertionIndex (const typename ALUSimplexGrid< 3, 3 >::LeafIntersection &intersection) const
 obtain a boundary's insertion index
virtual bool wasInserted (const typename Grid::LeafIntersection &intersection) const
virtual bool wasInserted (const typename ALUSimplexGrid< 3, 3 >::LeafIntersection &intersection) const
 determine whether an intersection was inserted

Static Public Attributes

static const ALU3dGridElementType elementType
static const unsigned int dimension
 dimension of the grid
static const unsigned int dimensionworld

Protected Types

enum  
 

The grid world dimension.

More...

Protected Member Functions

 GridFactory (const bool realGrid, const MPICommunicatorType &communicator=Grid::defaultCommunicator())
 constructor taking verbosity flag

Friends

class ALULocalGeometryStorage

Detailed Description

template<>
class Dune::GridFactory< ALUSimplexGrid< 3, 3 > >

Specialization of the generic GridFactory for ALUSimplexGrid<3,3>


Member Typedef Documentation

typedef Grid::ctype Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::ctype [inherited]

Type used by the grid for coordinates.

Reimplemented from Dune::GridFactoryInterface< ALUSimplexGrid< 3, 3 > >.

typedef DuneBoundaryProjection< 3 > Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::DuneBoundaryProjectionType [inherited]

type of boundary projection class

typedef BaseType::Grid Dune::GridFactory< ALUSimplexGrid< 3, 3 > >::Grid
typedef ALUGridTransformation< ctype, dimensionworld > Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::Transformation [inherited]
typedef Transformation::WorldMatrix Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::WorldMatrix [inherited]

type of matrix from world coordinates to world coordinates

typedef Transformation::WorldVector Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::WorldVector [inherited]

type of vector for world coordinates


Member Enumeration Documentation

anonymous enum [protected, inherited]

The grid world dimension.


Constructor & Destructor Documentation

Dune::GridFactory< ALUSimplexGrid< 3, 3 > >::GridFactory ( const MPICommunicatorType communicator = Grid::defaultCommunicator()  )  [inline, explicit]

Default constructor.

Dune::GridFactory< ALUSimplexGrid< 3, 3 > >::GridFactory ( const std::string &  filename,
const MPICommunicatorType communicator = Grid::defaultCommunicator() 
) [inline]

constructor taking filename

Dune::GridFactory< ALUSimplexGrid< 3, 3 > >::GridFactory ( const bool  realGrid,
const MPICommunicatorType communicator = Grid::defaultCommunicator() 
) [inline, protected]

constructor taking verbosity flag


Member Function Documentation

Grid* Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::createGrid (  )  [virtual, inherited]

finalize the grid creation and hand over the grid

The called takes responsibility for deleing the grid.

Implements Dune::GridFactoryInterface< ALUSimplexGrid< 3, 3 > >.

Grid* Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::createGrid ( const bool  addMissingBoundaries,
const std::string  dgfName = "" 
) [inherited]
Grid* Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::createGrid ( const bool  addMissingBoundaries,
bool  temporary,
const std::string  dgfName = "" 
) [inherited]
virtual void Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertBoundary ( const int  element,
const int  face,
const int  id 
) [virtual, inherited]

mark a face as boundary (and assign a boundary id)

Parameters:
[in] element index of the element, the face belongs to
[in] face local number of the face within the element
[in] id boundary id to assign to the face
virtual void Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertBoundary ( const GeometryType &  geometry,
const std::vector< unsigned int > &  faceVertices,
const int  id 
) [virtual, inherited]

insert a boundary element into the coarse grid

Note:
The order of the vertices must coincide with the vertex order in the corresponding DUNE reference element.
Parameters:
[in] geometry GeometryType of the boundary element
[in] faceVertices vertices of the boundary element
[in] id boundary identifier of the boundary element, the default value is 0 (invalid boundary id)
virtual void Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertBoundaryProjection ( const DuneBoundaryProjectionType bndProjection  )  [virtual, inherited]

insert a boundary projection object, (a copy is made)

Parameters:
[in] bndProjection instance of an ALUGridBoundaryProjection projecting vertices to a curved
virtual void Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertBoundaryProjection ( const GeometryType &  type,
const std::vector< unsigned int > &  vertices,
const DuneBoundaryProjectionType projection 
) [virtual, inherited]

insert a boundary projection into the macro grid

Parameters:
[in] type geometry type of boundary face
[in] vertices vertices of the boundary face
[in] projection boundary projection
Note:
The grid takes control of the projection object.
virtual void Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertBoundarySegment ( const std::vector< unsigned int > &  vertices  )  [virtual, inherited]

insert a boundary segment into the macro grid

Parameters:
[in] vertices vertex indices of boundary face

Implements Dune::GridFactoryInterface< ALUSimplexGrid< 3, 3 > >.

virtual void Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertBoundarySegment ( const std::vector< unsigned int > &  vertices,
const shared_ptr< BoundarySegment< 3, 3 > > &  boundarySegment 
) [virtual, inherited]

insert a shaped boundary segment into the macro grid

Parameters:
[in] vertices vertex indices of boundary face
[in] boundarySegment geometric realization of shaped boundary
virtual void Dune::GridFactoryInterface< ALUSimplexGrid< 3, 3 > >::insertBoundarySegment ( const std::vector< unsigned int > &  vertices,
const shared_ptr< BoundarySegment< dimension, dimworld > > &  boundarySegment 
) [inline, virtual, inherited]

insert an arbitrarily shaped boundary segment

This method inserts a boundary segment into the coarse grid.

Parameters:
[in] vertices the indices of the vertices of the segment
[in] boundarySegment user defined implementation of the boundary segment's geometry
virtual void Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertElement ( const GeometryType &  geometry,
const std::vector< unsigned int > &  vertices 
) [virtual, inherited]

insert an element into the coarse grid

Note:
The order of the vertices must coincide with the vertex order in the corresponding DUNE reference element.
Parameters:
[in] geometry GeometryType of the new element
[in] vertices vertices of the new element

Implements Dune::GridFactoryInterface< ALUSimplexGrid< 3, 3 > >.

virtual void Dune::GridFactoryInterface< ALUSimplexGrid< 3, 3 > >::insertElement ( const GeometryType &  type,
const std::vector< unsigned int > &  vertices,
const shared_ptr< VirtualFunction< FieldVector< ctype, dimension >, FieldVector< ctype, dimworld > > > &  elementParametrization 
) [inline, virtual, inherited]

Insert a parametrized element into the coarse grid.

Parameters:
type The GeometryType of the new element
vertices The vertices of the new element, using the DUNE numbering
elementParametrization A function prescribing the shape of this element

Make sure the inserted element is not inverted (this holds even for simplices). There are grids that can't handle inverted elements.

void Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertFaceTransformation ( const WorldMatrix matrix,
const WorldVector shift 
) [inherited]

add a face transformation (for periodic identification)

A face transformation is an affine mapping T from world coordinates to world coordinates. The grid factory then glues two faces f and g if T( f ) = g or T( g ) = f.

Parameters:
[in] matrix matrix describing the linear part of T
[in] shift vector describing T( 0 )
virtual unsigned int Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertionIndex ( const typename Codim< 0 >::Entity entity  )  const [inline, virtual, inherited]
virtual unsigned int Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertionIndex ( const typename Codim< dimension >::Entity entity  )  const [inline, virtual, inherited]
virtual unsigned int Dune::GridFactoryInterface< ALUSimplexGrid< 3, 3 > >::insertionIndex ( const typename ALUSimplexGrid< 3, 3 > ::LeafIntersection &  intersection  )  const [inline, virtual, inherited]

obtain a boundary's insertion index

Data can be associated to the created macro grid using the insertion index of each entity that has been inserted during the grid creation process.

Between grid construction (createGrid) and the first grid modification, this method allows to obtain this insertion index from the grid factory. This way, data can be stored using the index maps provided by the grid.

Parameters:
[in] intersection intersection whose insertion index is requested
Returns:
insertion index of the intersection
Note:
The insertion index can only be obtained for boundary intersections that were actually inserted (see also wasInserted).
virtual unsigned int Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertionIndex ( const typename Grid::LeafIntersection intersection  )  const [inline, virtual, inherited]
virtual void Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::insertVertex ( const VertexType &  pos  )  [virtual, inherited]

insert a vertex into the coarse grid

Parameters:
[in] pos position of the vertex
virtual void Dune::GridFactoryInterface< ALUSimplexGrid< 3, 3 > >::insertVertex ( const FieldVector< ctype, dimworld > &  pos  )  [pure virtual, inherited]

Insert a vertex into the coarse grid.

virtual bool Dune::GridFactoryInterface< ALUSimplexGrid< 3, 3 > >::wasInserted ( const typename ALUSimplexGrid< 3, 3 > ::LeafIntersection &  intersection  )  const [inline, virtual, inherited]

determine whether an intersection was inserted

This method allows checking wheter an intersection was actually inserted into the grid factory.

Note:
Not all boundary segments need to be inserted into the grid factory.
This method returns false for all interior intersections
Parameters:
[in] intersection intersection in question
Returns:
true, if the intersection was inserted
virtual bool Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::wasInserted ( const typename Grid::LeafIntersection intersection  )  const [inline, virtual, inherited]

Friends And Related Function Documentation

friend class ALULocalGeometryStorage [friend]

Member Data Documentation

const unsigned int Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::dimension [static, inherited]

dimension of the grid

Reimplemented from Dune::GridFactoryInterface< ALUSimplexGrid< 3, 3 > >.

const unsigned int Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::dimensionworld [static, inherited]
const ALU3dGridElementType Dune::ALU3dGridFactory< ALUSimplexGrid< 3, 3 > >::elementType [static, inherited]

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

Generated on Fri Apr 29 2011 with Doxygen (ver 1.7.1) [doxygen-log,error-log].