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

Compute first derivative at second-order (finite difference). More...

#include <dbpp_FirstDerivative.h>

Public Types

enum class  eBCtype { periodic , noncentered }

Public Member Functions

 FirstDerivative (eBCtype aBcTyp)
 ctor
std::valarray< double > d1x (const std::valarray< double > &aArray, float64 aDx)
 second order derivative (central difference)
void setBCtype ()
eBCtype getBCtype ()
float64 getDx () const
 grid spacing
short getDerivativeOrder () const
 derivative order

Private Attributes

eBCtype m_bcType
float64 m_dx

Detailed Description

Compute first derivative at second-order (finite difference).

Member Enumeration Documentation

◆ eBCtype

enum class dbpp::FirstDerivative::eBCtype
strong

An enum type Boundary condition type

Enumerator
periodic 

periodic

noncentered 

non-centered

Constructor & Destructor Documentation

◆ FirstDerivative()

dbpp::FirstDerivative::FirstDerivative ( eBCtype aBcTyp)
inline

ctor

Parameters
aBcTypderivative boundary condition type

Member Function Documentation

◆ d1x()

std::valarray< double > dbpp::FirstDerivative::d1x ( const std::valarray< double > & aArray,
float64 aDx )

second order derivative (central difference)

Parameters
aArrayvalues (field)
aDxgrid spacing
Returns
derivative values

◆ getBCtype()

eBCtype dbpp::FirstDerivative::getBCtype ( )
inline

◆ getDerivativeOrder()

short dbpp::FirstDerivative::getDerivativeOrder ( ) const
inline

derivative order

Returns
order

◆ getDx()

float64 dbpp::FirstDerivative::getDx ( ) const
inline

grid spacing

Returns
delta_x

◆ setBCtype()

void dbpp::FirstDerivative::setBCtype ( )
inline

Member Data Documentation

◆ m_bcType

eBCtype dbpp::FirstDerivative::m_bcType
private

boundary cnd type

◆ m_dx

float64 dbpp::FirstDerivative::m_dx
private

grid spacing


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