Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::CellBox< dimC > Class Template Reference

#include <formulafrmEformula.hh>

Inheritance diagram for concepts::CellBox< dimC >:
concepts::OutputOperator

Public Member Functions

 CellBox (const typename JacobianCell< dimC >::cell &cell)
 
 CellBox (const typename JacobianCell< dimC >::cell &cell, Real xMax)
 
virtual bool operator< (const CellBox< dimC > &box) const
 
virtual bool operator== (const CellBox< dimC > &box) const
 

Public Attributes

Real minX [dimC]
 
Real maxX [dimC]
 
const JacobianCell< dimC >::cell & cell
 
bool isDummy
 
uint key
 

Protected Member Functions

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

Detailed Description

template<uint dimC>
class concepts::CellBox< dimC >

CellBox with a specific order relation. This class represents a maximum tensored vertex box that contains a cell, built out of the vertex coordinate of that cell.

Precondition
The element is a vertex element, in particular has straight edges.
Remarks
could be adapted to other elements, defining a more general class that JacobianCell (to use the class Triangle for example)
Author
Robert Gruhlke, 2016

Definition at line 126 of file formulafrmEformula.hh.

Constructor & Destructor Documentation

◆ CellBox() [1/2]

template<uint dimC>
concepts::CellBox< dimC >::CellBox ( const typename JacobianCell< dimC >::cell &  cell)
inline

Definition at line 128 of file formulafrmEformula.hh.

◆ CellBox() [2/2]

template<uint dimC>
concepts::CellBox< dimC >::CellBox ( const typename JacobianCell< dimC >::cell &  cell,
Real  xMax 
)
inline

Definition at line 145 of file formulafrmEformula.hh.

Member Function Documentation

◆ info()

template<uint dimC>
virtual std::ostream & concepts::CellBox< dimC >::info ( std::ostream &  os) const
inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Definition at line 179 of file formulafrmEformula.hh.

◆ operator<()

template<uint dimC>
virtual bool concepts::CellBox< dimC >::operator< ( const CellBox< dimC > &  box) const
virtual

The Operator ensures that if a coordinate x > minX[0], then all following boxes in a set also have this property for this the special ordering case in higher dimension is essential.

◆ operator==()

template<uint dimC>
virtual bool concepts::CellBox< dimC >::operator== ( const CellBox< dimC > &  box) const
inlinevirtual

Definition at line 166 of file formulafrmEformula.hh.

Member Data Documentation

◆ cell

template<uint dimC>
const JacobianCell<dimC>::cell& concepts::CellBox< dimC >::cell

Definition at line 174 of file formulafrmEformula.hh.

◆ isDummy

template<uint dimC>
bool concepts::CellBox< dimC >::isDummy

Definition at line 175 of file formulafrmEformula.hh.

◆ key

template<uint dimC>
uint concepts::CellBox< dimC >::key

Definition at line 176 of file formulafrmEformula.hh.

◆ maxX

template<uint dimC>
Real concepts::CellBox< dimC >::maxX[dimC]

Definition at line 172 of file formulafrmEformula.hh.

◆ minX

template<uint dimC>
Real concepts::CellBox< dimC >::minX[dimC]

Definition at line 171 of file formulafrmEformula.hh.


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