DamBreak++ Wave Simulator 0.3
DamBreak++ Simulation Framework
Loading...
Searching...
No Matches
dbpp::Uh Class Reference

Container of nodal variables. More...

#include <dbpp_Uh.h>

Public Types

using NodalValue = NodalTpl<unsigned, float64, float64, float64>
 Nodal Variable is the "Basis" of numerical method approximation.
using vec_nval = std::vector<NodalValue>
 STL-container like interface (range)
using value_type = vec_nval::value_type
using pointer = value_type*
using iterator = pointer
using const_pointer = const value_type*
using const_iterator = const_pointer
using reference = value_type&
using const_reference = const value_type&
using range_diff_type = ptrdiff_t
using reverse_iterator = std::reverse_iterator<iterator>
using const_reverse_iterator = std::reverse_iterator<const_iterator>

Public Member Functions

auto cbegin () const
 Iterator access.
auto begin ()
auto cend () const
auto end ()
auto crbegin () const
auto rbegin ()
auto rend () const
auto crend () const
 Uh ()
 default ctor
 Uh (int32 df, Omega &oh)
 ctor from degree of freedom and domain
std::vector< double > to_stdVector (eNodalField aNvalComp=eNodalField::A) const
 Helper to retrieve component of nodal variable.
vec_nvalvecNodalVarArray ()
 Getter.
const vec_nvalvecNodalVarArray () const
 Getter.
NodalValueoperator[] (int32 nn)
 Accessor.
const NodalValueoperator[] (int32 nn) const
 Accessor.
std::size_t total_node_no () const

Private Attributes

int32 ndf
std::size_t m_totalNodeNo
vec_nval m_vecNodalVarArray

Friends

std::ostream & operator<< (std::ostream &, Uh &)
 output stream operator

Detailed Description

Container of nodal variables.

Member Typedef Documentation

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

using dbpp::Uh::const_reverse_iterator = std::reverse_iterator<const_iterator>

◆ iterator

◆ NodalValue

Nodal Variable is the "Basis" of numerical method approximation.

◆ pointer

◆ range_diff_type

using dbpp::Uh::range_diff_type = ptrdiff_t

◆ reference

◆ reverse_iterator

using dbpp::Uh::reverse_iterator = std::reverse_iterator<iterator>

◆ value_type

using dbpp::Uh::value_type = vec_nval::value_type

◆ vec_nval

using dbpp::Uh::vec_nval = std::vector<NodalValue>

STL-container like interface (range)

Constructor & Destructor Documentation

◆ Uh() [1/2]

dbpp::Uh::Uh ( )

default ctor

◆ Uh() [2/2]

dbpp::Uh::Uh ( int32 df,
Omega & oh )

ctor from degree of freedom and domain

Parameters
dfdegre of freedom
ohcomputational domain

Member Function Documentation

◆ begin()

auto dbpp::Uh::begin ( )
inline

◆ cbegin()

auto dbpp::Uh::cbegin ( ) const
inline

Iterator access.

Returns
iterator

◆ cend()

auto dbpp::Uh::cend ( ) const
inline

◆ crbegin()

auto dbpp::Uh::crbegin ( ) const
inline

◆ crend()

auto dbpp::Uh::crend ( ) const
inline

◆ end()

auto dbpp::Uh::end ( )
inline

◆ operator[]() [1/2]

NodalValue & dbpp::Uh::operator[] ( int32 nn)
inline

Accessor.

Parameters
nnnode index
Returns
nodal variable

◆ operator[]() [2/2]

const NodalValue & dbpp::Uh::operator[] ( int32 nn) const
inline

Accessor.

Parameters
nnnode index
Returns
nodal variable

◆ rbegin()

auto dbpp::Uh::rbegin ( )
inline

◆ rend()

auto dbpp::Uh::rend ( ) const
inline

◆ to_stdVector()

std::vector< double > dbpp::Uh::to_stdVector ( eNodalField aNvalComp = eNodalField::A) const
inline

Helper to retrieve component of nodal variable.

Parameters
aNvalCompnodal variable component
Returns
vector of values

◆ total_node_no()

std::size_t dbpp::Uh::total_node_no ( ) const
inline
Returns

◆ vecNodalVarArray() [1/2]

vec_nval & dbpp::Uh::vecNodalVarArray ( )
inline

Getter.

Returns
vector of nodal variable

◆ vecNodalVarArray() [2/2]

const vec_nval & dbpp::Uh::vecNodalVarArray ( ) const
inline

Getter.

Returns
vector of nodal variable

◆ operator<<

std::ostream & operator<< ( std::ostream & ,
Uh &  )
friend

output stream operator

Parameters
streamoperator
nodalvariables
Returns
output stream

Member Data Documentation

◆ m_totalNodeNo

std::size_t dbpp::Uh::m_totalNodeNo
private

number of grid node (discretization)

◆ m_vecNodalVarArray

vec_nval dbpp::Uh::m_vecNodalVarArray
private

nodal variables

◆ ndf

int32 dbpp::Uh::ndf
private

number of degree freedom


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