Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::SubspaceHelper< F, G > Class Template Reference
Inheritance diagram for concepts::SubspaceHelper< F, G >:
concepts::SpaceHelper< F, G > concepts::OutputOperator

Public Member Functions

 SubspaceHelper (G &prebuild, uint spcNo, const BoundaryConditions *bc=0, const CellConditions *cc=0, uint *const offset=0, uint *const idx=0)
 
virtual void reset ()
 Reset the index counter.
 
virtual uintidx ()
 
virtual const uintidx () const
 
bool ownIndex () const
 
virtual uint spcNo () const
 
uint offset () const
 Returns the offset.
 
const BoundaryConditionsbc () const
 Returns boundary conditions.
 
const CellConditionscc () const
 Returns cell conditions.
 
void set_bc (const BoundaryConditions *bc)
 Reset boundary conditions to bc.
 
G & prebuild ()
 Returns space pre builder.
 
bool passive (const concepts::Connector &cntr) const
 Returns if an entitiy of dimension dim is marked as passive.
 
const concepts::Set< const concepts::Connector * > passive () const
 
void setPassive (const concepts::Connector &cntr)
 Mark a connector as passive.
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Detailed Description

template<class F, class G>
class concepts::SubspaceHelper< F, G >

Definition at line 162 of file spacePreBuilder.hh.

Constructor & Destructor Documentation

◆ SubspaceHelper()

template<class F , class G >
concepts::SubspaceHelper< F, G >::SubspaceHelper ( G &  prebuild,
uint  spcNo,
const BoundaryConditions bc = 0,
const CellConditions cc = 0,
uint *const  offset = 0,
uint *const  idx = 0 
)
inline

Constructor

Parameters
prebuildspace prebuilder itself (not deleted in destructor)
spcNoNumber to distinguish between global indices on same topological entity.
bcpointer to boundary conditions
offsetpointer to offset
idxpointer to index, e.g. for domain decomposition

Definition at line 173 of file spacePreBuilder.hh.

◆ ~SubspaceHelper()

template<class F , class G >
virtual concepts::SubspaceHelper< F, G >::~SubspaceHelper ( )
inlinevirtual

Definition at line 180 of file spacePreBuilder.hh.

Member Function Documentation

◆ bc()

template<class F , class G >
const BoundaryConditions * concepts::SpaceHelper< F, G >::bc ( ) const
inlineinherited

Returns boundary conditions.

Definition at line 105 of file spacePreBuilder.hh.

◆ cc()

template<class F , class G >
const CellConditions * concepts::SpaceHelper< F, G >::cc ( ) const
inlineinherited

Returns cell conditions.

Definition at line 107 of file spacePreBuilder.hh.

◆ idx() [1/2]

template<class F , class G >
virtual uint & concepts::SubspaceHelper< F, G >::idx ( )
inlinevirtual

Returns the next index for the space. It can be used as offset for the next subspace. Because it returns the reference, then if the subspace is built, the offset of the next subspace is automatically right.

Implements concepts::SpaceHelper< F, G >.

Definition at line 190 of file spacePreBuilder.hh.

◆ idx() [2/2]

template<class F , class G >
virtual const uint & concepts::SubspaceHelper< F, G >::idx ( ) const
inlinevirtual

Implements concepts::SpaceHelper< F, G >.

Definition at line 193 of file spacePreBuilder.hh.

◆ info()

template<class F , class G >
std::ostream & concepts::SubspaceHelper< F, G >::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::SpaceHelper< F, G >.

Definition at line 215 of file spacePreBuilder.hh.

◆ offset()

template<class F , class G >
uint concepts::SubspaceHelper< F, G >::offset ( ) const
inline

Returns the offset.

Definition at line 200 of file spacePreBuilder.hh.

◆ ownIndex()

template<class F , class G >
bool concepts::SubspaceHelper< F, G >::ownIndex ( ) const
inline

Definition at line 197 of file spacePreBuilder.hh.

◆ passive() [1/2]

template<class F , class G >
const concepts::Set< const concepts::Connector * > concepts::SpaceHelper< F, G >::passive ( ) const
inlineinherited

Definition at line 132 of file spacePreBuilder.hh.

◆ passive() [2/2]

template<class F , class G >
bool concepts::SpaceHelper< F, G >::passive ( const concepts::Connector cntr) const
inlineinherited

Returns if an entitiy of dimension dim is marked as passive.

Definition at line 125 of file spacePreBuilder.hh.

◆ prebuild()

template<class F , class G >
G & concepts::SpaceHelper< F, G >::prebuild ( )
inlineinherited

Returns space pre builder.

Definition at line 113 of file spacePreBuilder.hh.

◆ reset()

template<class F , class G >
virtual void concepts::SubspaceHelper< F, G >::reset ( )
inlinevirtual

Reset the index counter.

Implements concepts::SpaceHelper< F, G >.

Definition at line 184 of file spacePreBuilder.hh.

◆ set_bc()

template<class F , class G >
void concepts::SpaceHelper< F, G >::set_bc ( const BoundaryConditions bc)
inlineinherited

Reset boundary conditions to bc.

Definition at line 109 of file spacePreBuilder.hh.

◆ setPassive()

template<class F , class G >
void concepts::SpaceHelper< F, G >::setPassive ( const concepts::Connector cntr)
inlineinherited

Mark a connector as passive.

Definition at line 129 of file spacePreBuilder.hh.

◆ spcNo()

template<class F , class G >
virtual uint concepts::SubspaceHelper< F, G >::spcNo ( ) const
inlinevirtual

Returns a number to distinguish between global indices on same topological entity. Here 0, but meaning can come in derivated classes.

Reimplemented from concepts::SpaceHelper< F, G >.

Definition at line 198 of file spacePreBuilder.hh.


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