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

Physical boundary condition (computational domain) based on characteristic equation ... More...

#include <dbpp_PhysicalBoundaryCnd.h>

Public Member Functions

 PhysicalBoundaryCnd ()
 Default constructor.
 PhysicalBoundaryCnd (PhysicalSystem *aPhySys)
 reference on physical system
 PhysicalBoundaryCnd (PhyBCNdlConstraint aLeftBC, PhyBCNdlConstraint aRightBC)
PhyBCNdlConstraint getLeftEnd () const
 Left boundary.
PhyBCNdlConstraint getRightEnd () const
 Right boundary.
void update ()
 Update constraint values at both end.
PhysicalSystemgetPhysicalSystem () const noexcept
 Physical system.
virtual void setLeftBC (const std::tuple< unsigned, float64, float64, float64 > &aLeftPhyBnd)
 Set left constraint.
virtual void setRightBC (std::tuple< unsigned, float64, float64, float64 > aRightPhyBnd)
 Set right constraint.

Private Attributes

PhysicalSystemm_phsys
PhyBCNdlConstraint m_leftEnd
PhyBCNdlConstraint m_rightEnd

Detailed Description

Physical boundary condition (computational domain) based on characteristic equation ...

Constructor & Destructor Documentation

◆ PhysicalBoundaryCnd() [1/3]

dbpp::PhysicalBoundaryCnd::PhysicalBoundaryCnd ( )
inline

Default constructor.

◆ PhysicalBoundaryCnd() [2/3]

dbpp::PhysicalBoundaryCnd::PhysicalBoundaryCnd ( PhysicalSystem * aPhySys)

reference on physical system

Parameters
aPhySysphysical system

◆ PhysicalBoundaryCnd() [3/3]

dbpp::PhysicalBoundaryCnd::PhysicalBoundaryCnd ( PhyBCNdlConstraint aLeftBC,
PhyBCNdlConstraint aRightBC )
Parameters
aLeftBC
aRightBC

Member Function Documentation

◆ getLeftEnd()

PhyBCNdlConstraint dbpp::PhysicalBoundaryCnd::getLeftEnd ( ) const
inline

Left boundary.

Returns
Physical contraint value

◆ getPhysicalSystem()

PhysicalSystem * dbpp::PhysicalBoundaryCnd::getPhysicalSystem ( ) const
inlinenoexcept

Physical system.

Returns
instance of the physical refered to

◆ getRightEnd()

PhyBCNdlConstraint dbpp::PhysicalBoundaryCnd::getRightEnd ( ) const
inline

Right boundary.

Returns
Physical contraint value

◆ setLeftBC()

virtual void dbpp::PhysicalBoundaryCnd::setLeftBC ( const std::tuple< unsigned, float64, float64, float64 > & aLeftPhyBnd)
inlinevirtual

Set left constraint.

Parameters
aLeftPhyBndleft boundary values

◆ setRightBC()

virtual void dbpp::PhysicalBoundaryCnd::setRightBC ( std::tuple< unsigned, float64, float64, float64 > aRightPhyBnd)
inlinevirtual

Set right constraint.

Parameters
aRightPhyBndright boundary values

◆ update()

void dbpp::PhysicalBoundaryCnd::update ( )

Update constraint values at both end.

Member Data Documentation

◆ m_leftEnd

PhyBCNdlConstraint dbpp::PhysicalBoundaryCnd::m_leftEnd
private

left constraint

◆ m_phsys

PhysicalSystem* dbpp::PhysicalBoundaryCnd::m_phsys
private

physical system

◆ m_rightEnd

PhyBCNdlConstraint dbpp::PhysicalBoundaryCnd::m_rightEnd
private

right constraint


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