dune-grid 2.9.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Static Protected Member Functions | List of all members
Dune::DuneBoundaryProjection< dimworld > Struct Template Referenceabstract

Interface class for vertex projection at the boundary. More...

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

Inheritance diagram for Dune::DuneBoundaryProjection< dimworld >:
Inheritance graph

Public Types

typedef DuneBoundaryProjection< dimworld > ThisType
 
typedef BoundarySegmentBackupRestore< DuneBoundaryProjection< dimworld > > BaseType
 
typedef BaseType::ObjectStreamType ObjectStreamType
 
typedef FieldVector< double, dimworld > CoordinateType
 type of coordinate vector More...
 

Public Member Functions

virtual ~DuneBoundaryProjection ()
 destructor More...
 
virtual CoordinateType operator() (const CoordinateType &global) const =0
 projection operator projection a global coordinate More...
 
virtual 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

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

Protected Types

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

Static Protected Member Functions

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

Detailed Description

template<int dimworld>
struct Dune::DuneBoundaryProjection< dimworld >

Interface class for vertex projection at the boundary.

Member Typedef Documentation

◆ BaseType

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

◆ BoundarySegment

typedef DuneBoundaryProjection< dimworld > Dune::BoundarySegmentBackupRestore< DuneBoundaryProjection< dimworld > >::BoundarySegment
protectedinherited

type of BoundarySegment interface class

◆ CoordinateType

template<int dimworld>
typedef FieldVector< double, dimworld> Dune::DuneBoundaryProjection< dimworld >::CoordinateType

type of coordinate vector

◆ 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

◆ ObjectStreamType

template<int dimworld>
typedef BaseType::ObjectStreamType Dune::DuneBoundaryProjection< dimworld >::ObjectStreamType

◆ ThisType

template<int dimworld>
typedef DuneBoundaryProjection< dimworld > Dune::DuneBoundaryProjection< dimworld >::ThisType

Constructor & Destructor Documentation

◆ ~DuneBoundaryProjection()

template<int dimworld>
virtual Dune::DuneBoundaryProjection< dimworld >::~DuneBoundaryProjection ( )
inlinevirtual

destructor

Member Function Documentation

◆ backup()

template<int dimworld>
virtual void Dune::DuneBoundaryProjection< dimworld >::backup ( ObjectStreamType buffer) const
inlinevirtual

write DuneBoundaryProjection's data to stream buffer

Parameters
bufferbuffer to store data

Reimplemented in Dune::BoundarySegmentWrapper< dim, dimworld >.

◆ operator()()

template<int dimworld>
virtual CoordinateType Dune::DuneBoundaryProjection< dimworld >::operator() ( const CoordinateType global) const
pure virtual

◆ registerFactory()

static int Dune::BoundarySegmentBackupRestore< DuneBoundaryProjection< dimworld > >::registerFactory ( )
inlinestaticprotectedinherited

◆ 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)
inlinestatic

◆ restoreFromBuffer() [2/2]

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

◆ toBuffer() [1/2]

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

◆ toBuffer() [2/2]

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

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