dune-grid 2.9.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | List of all members
Dune::BoundarySegmentWrapper< dim, dimworld > Class Template Reference

#include <dune/grid/common/boundaryprojection.hh>

Inheritance diagram for Dune::BoundarySegmentWrapper< dim, dimworld >:
Inheritance graph

Public Types

typedef Base::CoordinateType CoordinateType
 
typedef Dune::BoundarySegment< dim, dimworld > BoundarySegment
 
typedef BoundarySegmentBackupRestore< DuneBoundaryProjection< dimworld > > BaseType
 

Public Member Functions

 BoundarySegmentWrapper (const GeometryType &type, const std::vector< CoordinateType > &vertices, const std::shared_ptr< BoundarySegment > &boundarySegment)
 
 BoundarySegmentWrapper (ObjectStreamType &buffer)
 
CoordinateType operator() (const CoordinateType &global) const
 projection operator projection a global coordinate More...
 
const BoundarySegmentboundarySegment () const
 
void backup (ObjectStreamType &buffer) const
 write DuneBoundaryProjection's data to stream buffer More...
 
template<class BufferImp >
void toBuffer (BufferImp &buffer) const
 
template<class BufferImp >
void toBuffer (MessageBufferIF< BufferImp > &buffer) const
 

Static Public Member Functions

static void registerFactory ()
 
template<class BufferImp >
static std::unique_ptr< ThisTyperestoreFromBuffer (BufferImp &buffer)
 
template<class BufferImp >
static std::unique_ptr< ThisTyperestoreFromBuffer (MessageBufferIF< BufferImp > &buffer)
 

Protected Types

typedef Dune::ParameterizedObjectFactory< std::unique_ptr< BoundarySegment >(ObjectStreamType &), int > FactoryType
 type of factory creating a unique_ptr from an ObjectStreamType More...
 

Protected Member Functions

FaceMapping readFaceMapping (ObjectStreamType &buffer)
 

Static Protected Member Functions

static int & key ()
 
static std::unique_ptr< BoundarySegmentrestore (ObjectStreamType &in)
 create an object of BoundarySegment type from a previously registered factory linked to key. More...
 

Detailed Description

template<int dim, int dimworld>
class Dune::BoundarySegmentWrapper< dim, dimworld >
Template Parameters
dimDimension of the grid

Member Typedef Documentation

◆ BaseType

template<int dimworld>
typedef BoundarySegmentBackupRestore< DuneBoundaryProjection< dimworld > > Dune::DuneBoundaryProjection< dimworld >::BaseType
inherited

◆ BoundarySegment

template<int dim, int dimworld>
typedef Dune::BoundarySegment< dim, dimworld > Dune::BoundarySegmentWrapper< dim, dimworld >::BoundarySegment

◆ CoordinateType

template<int dim, int dimworld>
typedef Base::CoordinateType Dune::BoundarySegmentWrapper< dim, dimworld >::CoordinateType

◆ FactoryType

typedef Dune::ParameterizedObjectFactory< std::unique_ptr< BoundarySegment >( ObjectStreamType& ), int > Dune::BoundarySegmentBackupRestore< DuneBoundaryProjection< dimworld > >::FactoryType
protectedinherited

type of factory creating a unique_ptr from an ObjectStreamType

Constructor & Destructor Documentation

◆ BoundarySegmentWrapper() [1/2]

template<int dim, int dimworld>
Dune::BoundarySegmentWrapper< dim, dimworld >::BoundarySegmentWrapper ( const GeometryType &  type,
const std::vector< CoordinateType > &  vertices,
const std::shared_ptr< BoundarySegment > &  boundarySegment 
)
inline

constructor

Parameters
[in]typegeometry type of the boundary face
[in]verticesvertices of the boundary face
[in]boundarySegmentgeometric realization of the shaped boundary
Note
The BoundarySegmentWrapper takes control of the boundary segment.

◆ BoundarySegmentWrapper() [2/2]

template<int dim, int dimworld>
Dune::BoundarySegmentWrapper< dim, dimworld >::BoundarySegmentWrapper ( ObjectStreamType buffer)
inline

Member Function Documentation

◆ backup()

template<int dim, int dimworld>
void Dune::BoundarySegmentWrapper< dim, dimworld >::backup ( ObjectStreamType buffer) const
inlinevirtual

write DuneBoundaryProjection's data to stream buffer

Parameters
bufferbuffer to store data

Reimplemented from Dune::DuneBoundaryProjection< dimworld >.

◆ boundarySegment()

template<int dim, int dimworld>
const BoundarySegment & Dune::BoundarySegmentWrapper< dim, dimworld >::boundarySegment ( ) const
inline

◆ key()

template<int dim, int dimworld>
static int & Dune::BoundarySegmentWrapper< dim, dimworld >::key ( )
inlinestaticprotected

◆ operator()()

template<int dim, int dimworld>
CoordinateType Dune::BoundarySegmentWrapper< dim, dimworld >::operator() ( const CoordinateType global) const
inlinevirtual

projection operator projection a global coordinate

Implements Dune::DuneBoundaryProjection< dimworld >.

◆ readFaceMapping()

template<int dim, int dimworld>
FaceMapping Dune::BoundarySegmentWrapper< dim, dimworld >::readFaceMapping ( ObjectStreamType buffer)
inlineprotected

◆ registerFactory()

template<int dim, int dimworld>
static void Dune::BoundarySegmentWrapper< dim, dimworld >::registerFactory ( )
inlinestatic

◆ restore()

static std::unique_ptr< BoundarySegment > Dune::BoundarySegmentBackupRestore< DuneBoundaryProjection< dimworld > >::restore ( ObjectStreamType in)
inlinestaticprotectedinherited

create an object of BoundarySegment type from a previously registered factory linked to key.

Parameters
instream buffer previously written with backup containing key and object data
Returns
Object derived from BoundarySegment.

◆ restoreFromBuffer() [1/2]

template<int dimworld>
template<class BufferImp >
static std::unique_ptr< ThisType > Dune::DuneBoundaryProjection< dimworld >::restoreFromBuffer ( BufferImp &  buffer)
inlinestaticinherited

◆ restoreFromBuffer() [2/2]

template<int dimworld>
template<class BufferImp >
static std::unique_ptr< ThisType > Dune::DuneBoundaryProjection< dimworld >::restoreFromBuffer ( MessageBufferIF< BufferImp > &  buffer)
inlinestaticinherited

◆ toBuffer() [1/2]

template<int dimworld>
template<class BufferImp >
void Dune::DuneBoundaryProjection< dimworld >::toBuffer ( BufferImp &  buffer) const
inlineinherited

◆ toBuffer() [2/2]

template<int dimworld>
template<class BufferImp >
void Dune::DuneBoundaryProjection< dimworld >::toBuffer ( MessageBufferIF< BufferImp > &  buffer) const
inlineinherited

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