Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::MappingEdge3d Class Referenceabstract

#include <mappingEdge3D.hh>

Inheritance diagram for concepts::MappingEdge3d:
concepts::Map1d concepts::OutputOperator concepts::CircleMappingEdge3d concepts::MappingHexahedronEdge3d concepts::MappingStraightEdge3d

Public Member Functions

 MappingEdge3d (const Real3d &vtx0, const Real3d &vtx1)
 
 MappingEdge3d (const MappingEdge3d &other)
 Copy constructor.
 
 ~MappingEdge3d () override
 Virtual destructor.
 
virtual MappingEdge3dclone () const =0
 
virtual MappingEdge3dinverse () const =0
 
virtual Real3d operator() (const Real t) const =0
 
virtual Real3d derivative (const Real t, const uint n=1) const =0
 
const Real3dvtx (uint i) const
 

Protected Member Functions

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

Protected Attributes

std::array< Real3d, 2 > vtx_
 Physical vertices $ \{ F_K(0), F_K(1) \} $.
 

Detailed Description

Base class for an edge element map $ F_K : [0,1] \to \mathbb{R}^3 $.

Todo:
Currently this class stores vertices to be consistent across dimensions 2D and 3D, which may be changed in the future.
Author
Lukas Drescher, 2014

Definition at line 31 of file mappingEdge3D.hh.

Constructor & Destructor Documentation

◆ MappingEdge3d()

concepts::MappingEdge3d::MappingEdge3d ( const Real3d vtx0,
const Real3d vtx1 
)

Constructor.

Parameters
vtx0physical coordinate $ F_K(0) $ of first vertex of the edge
vtx1physical coordinate $ F_K(1) $ of second vertex of the edge

Member Function Documentation

◆ clone()

virtual MappingEdge3d * concepts::MappingEdge3d::clone ( ) const
pure virtual

Virtual constructor. Create a heap-allocated copy of this edge.

Returns
Pointer to heap-allocated edge copy. To be deleted by the user.

Implemented in concepts::MappingStraightEdge3d, concepts::CircleMappingEdge3d, and concepts::MappingHexahedronEdge3d.

◆ derivative()

virtual Real3d concepts::MappingEdge3d::derivative ( const Real  t,
const uint  n = 1 
) const
pure virtual

Evaluates the n-th derivative of the edge mapping at the coordinate t.

Parameters
norder of the derivative (<= 1 for most concrete types)
Returns
$ F^{(n)}_K(t)$

Implemented in concepts::MappingStraightEdge3d, concepts::CircleMappingEdge3d, and concepts::MappingHexahedronEdge3d.

◆ info()

std::ostream & concepts::MappingEdge3d::info ( std::ostream &  os) const
overrideprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::Map1d.

Reimplemented in concepts::MappingStraightEdge3d, and concepts::MappingHexahedronEdge3d.

◆ inverse()

virtual MappingEdge3d * concepts::MappingEdge3d::inverse ( ) const
pure virtual

Create a heap-allocated copy of this edge with reversed parametrization.

Returns
Pointer to heap-allocated edge copy. Has to be deleted by the user.

Implemented in concepts::MappingStraightEdge3d, concepts::CircleMappingEdge3d, and concepts::MappingHexahedronEdge3d.

◆ operator()()

virtual Real3d concepts::MappingEdge3d::operator() ( const Real  t) const
pure virtual

Evaluates the edge mapping at the coordinate t.

Returns
$ F_K(t) $

Implemented in concepts::MappingStraightEdge3d, concepts::CircleMappingEdge3d, and concepts::MappingHexahedronEdge3d.

◆ vtx()

const Real3d & concepts::MappingEdge3d::vtx ( uint  i) const
inline

Returns i-th physical vertex of the edge

Returns
$ F_K( i ) $

Definition at line 64 of file mappingEdge3D.hh.

Member Data Documentation

◆ vtx_

std::array<Real3d,2> concepts::MappingEdge3d::vtx_
protected

Physical vertices $ \{ F_K(0), F_K(1) \} $.

Definition at line 68 of file mappingEdge3D.hh.


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