Flow123d  JS_before_hm-2088-g1c00063e5
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Side Class Reference

#include <accessors.hh>

Collaboration diagram for Side:
Collaboration graph
[legend]

Public Member Functions

 Side ()
 Default invalid side accessor constructor. More...
 
 Side (const MeshBase *mesh, unsigned int elem_idx, unsigned int set_lnum)
 Valid edge accessor constructor. More...
 
double measure () const
 Calculate metrics of the side. More...
 
arma::vec3 centre () const
 Centre of side. More...
 
arma::vec3 normal () const
 Vector of (generalized) normal. More...
 
double diameter () const
 Calculate the side diameter. More...
 
unsigned int dim () const
 Returns dimension of the side, that is dimension of the element minus one. More...
 
bool is_external () const
 Returns true for all sides either on boundary or connected to vb neigboring. More...
 
bool is_boundary () const
 Returns true for side on the boundary. More...
 
NodeAccessor< 3 > node (unsigned int i) const
 Returns node for given local index i on the side. More...
 
ElementAccessor< 3 > element () const
 Returns iterator to the element of the side. More...
 
unsigned int edge_idx () const
 Returns global index of the edge connected to the side. More...
 
Edge edge () const
 Returns pointer to the edge connected to the side. More...
 
Boundary cond () const
 
unsigned int cond_idx () const
 Returns global index of the prescribed boundary condition. More...
 
unsigned int n_nodes () const
 Returns number of nodes of the side. More...
 
const MeshBasemesh () const
 Returns pointer to the mesh. More...
 
unsigned int side_idx () const
 Returns local index of the side on the element. More...
 
unsigned int elem_idx () const
 Returns index of element in Mesh::element_vec_. More...
 
bool is_valid () const
 Returns true if the side has assigned element. More...
 
void inc ()
 Iterate over local sides of the element. More...
 
bool operator== (const Side &other) const
 
bool operator!= (const Side &other) const
 

Private Member Functions

arma::vec3 normal_point () const
 This is necessary by current DofHandler, should change this. More...
 
arma::vec3 normal_line () const
 
arma::vec3 normal_triangle () const
 

Private Attributes

const MeshBasemesh_
 Pointer to Mesh to which belonged. More...
 
unsigned int elem_idx_
 Index of element in Mesh::element_vec_. More...
 
unsigned int side_idx_
 Local # of side in element (to remove it, we heve to remove calc_side_rhs) More...
 

Detailed Description

Definition at line 396 of file accessors.hh.

Constructor & Destructor Documentation

◆ Side() [1/2]

Side::Side ( )
inline

Default invalid side accessor constructor.

Definition at line 182 of file accessors_impl.hh.

◆ Side() [2/2]

Side::Side ( const MeshBase mesh,
unsigned int  elem_idx,
unsigned int  set_lnum 
)
inline

Valid edge accessor constructor.

Definition at line 186 of file accessors_impl.hh.

Member Function Documentation

◆ centre()

arma::vec3 Side::centre ( ) const

Centre of side.

Definition at line 116 of file accessors.cc.

Here is the caller graph for this function:

◆ cond()

Boundary Side::cond ( ) const
inline

Returns boundary condition prescribed on the side. Fails on assert if side if not on boundary and no BC is prescribed.

Definition at line 225 of file accessors_impl.hh.

Here is the caller graph for this function:

◆ cond_idx()

unsigned int Side::cond_idx ( ) const
inline

Returns global index of the prescribed boundary condition.

Definition at line 229 of file accessors_impl.hh.

Here is the caller graph for this function:

◆ diameter()

double Side::diameter ( ) const

Calculate the side diameter.

Definition at line 132 of file accessors.cc.

Here is the caller graph for this function:

◆ dim()

unsigned int Side::dim ( ) const
inline

Returns dimension of the side, that is dimension of the element minus one.

Definition at line 192 of file accessors_impl.hh.

Here is the caller graph for this function:

◆ edge()

Edge Side::edge ( ) const
inline

Returns pointer to the edge connected to the side.

Definition at line 221 of file accessors_impl.hh.

Here is the caller graph for this function:

◆ edge_idx()

unsigned int Side::edge_idx ( ) const
inline

Returns global index of the edge connected to the side.

Definition at line 217 of file accessors_impl.hh.

Here is the caller graph for this function:

◆ elem_idx()

unsigned int Side::elem_idx ( ) const
inline

Returns index of element in Mesh::element_vec_.

Definition at line 454 of file accessors.hh.

Here is the caller graph for this function:

◆ element()

ElementAccessor< 3 > Side::element ( ) const
inline

Returns iterator to the element of the side.

Definition at line 212 of file accessors_impl.hh.

Here is the caller graph for this function:

◆ inc()

void Side::inc ( )
inline

Iterate over local sides of the element.

Definition at line 462 of file accessors.hh.

Here is the caller graph for this function:

◆ is_boundary()

bool Side::is_boundary ( ) const
inline

Returns true for side on the boundary.

Definition at line 202 of file accessors_impl.hh.

Here is the caller graph for this function:

◆ is_external()

bool Side::is_external ( ) const
inline

Returns true for all sides either on boundary or connected to vb neigboring.

Definition at line 197 of file accessors_impl.hh.

Here is the caller graph for this function:

◆ is_valid()

bool Side::is_valid ( ) const
inline

Returns true if the side has assigned element.

Definition at line 458 of file accessors.hh.

Here is the caller graph for this function:

◆ measure()

double Side::measure ( ) const

Calculate metrics of the side.

Definition at line 27 of file accessors.cc.

Here is the caller graph for this function:

◆ mesh()

const MeshBase* Side::mesh ( ) const
inline

Returns pointer to the mesh.

Definition at line 446 of file accessors.hh.

Here is the caller graph for this function:

◆ n_nodes()

unsigned int Side::n_nodes ( ) const
inline

Returns number of nodes of the side.

Definition at line 442 of file accessors.hh.

Here is the caller graph for this function:

◆ node()

NodeAccessor< 3 > Side::node ( unsigned int  i) const
inline

Returns node for given local index i on the side.

Definition at line 206 of file accessors_impl.hh.

Here is the caller graph for this function:

◆ normal()

arma::vec3 Side::normal ( ) const

Vector of (generalized) normal.

Definition at line 48 of file accessors.cc.

Here is the caller graph for this function:

◆ normal_line()

arma::vec3 Side::normal_line ( ) const
private

Definition at line 80 of file accessors.cc.

Here is the caller graph for this function:

◆ normal_point()

arma::vec3 Side::normal_point ( ) const
private

This is necessary by current DofHandler, should change this.

Definition at line 64 of file accessors.cc.

Here is the caller graph for this function:

◆ normal_triangle()

arma::vec3 Side::normal_triangle ( ) const
private

Definition at line 101 of file accessors.cc.

Here is the caller graph for this function:

◆ operator!=()

bool Side::operator!= ( const Side other) const
inline

Definition at line 472 of file accessors.hh.

◆ operator==()

bool Side::operator== ( const Side other) const
inline

Definition at line 467 of file accessors.hh.

◆ side_idx()

unsigned int Side::side_idx ( ) const
inline

Returns local index of the side on the element.

Definition at line 450 of file accessors.hh.

Here is the caller graph for this function:

Member Data Documentation

◆ elem_idx_

unsigned int Side::elem_idx_
private

Index of element in Mesh::element_vec_.

Definition at line 487 of file accessors.hh.

◆ mesh_

const MeshBase* Side::mesh_
private

Pointer to Mesh to which belonged.

Definition at line 486 of file accessors.hh.

◆ side_idx_

unsigned int Side::side_idx_
private

Local # of side in element (to remove it, we heve to remove calc_side_rhs)

Definition at line 488 of file accessors.hh.


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