walberla::EKReactionBase Class Reference

#include <EKReactionBase.hpp>

Inheritance diagram for walberla::EKReactionBase:

Public Types
using	reactants_type = std::vector< std::shared_ptr< EKReactant > >

Public Member Functions
	EKReactionBase (std::shared_ptr< LatticeWalberla > lattice, reactants_type reactants, double coefficient)
virtual	~EKReactionBase ()=default
void	set_coefficient (double coefficient) noexcept
double	get_coefficient () const noexcept
auto	get_lattice () const noexcept
auto const &	get_reactants () const noexcept
virtual void	perform_reaction ()=0

Detailed Description

Definition at line 31 of file EKReactionBase.hpp.

Member Typedef Documentation

reactants_type

using walberla::EKReactionBase::reactants_type = std::vector<std::shared_ptr<EKReactant> >

Definition at line 33 of file EKReactionBase.hpp.

Constructor & Destructor Documentation

EKReactionBase()

walberla::EKReactionBase::EKReactionBase ( std::shared_ptr< LatticeWalberla >  lattice, reactants_type  reactants, double  coefficient  )

inline

Definition at line 41 of file EKReactionBase.hpp.

~EKReactionBase()

virtual walberla::EKReactionBase::~EKReactionBase ( )

virtualdefault

Member Function Documentation

get_coefficient()

double walberla::EKReactionBase::get_coefficient ( ) const

inlinenoexcept

Definition at line 51 of file EKReactionBase.hpp.

Referenced by walberla::EKReactionImplIndexed::perform_reaction().

get_lattice()

auto walberla::EKReactionBase::get_lattice ( ) const

inlinenoexcept

Definition at line 54 of file EKReactionBase.hpp.

Referenced by walberla::EKReactionImplIndexed::boundary_update(), walberla::EKReactionImplIndexed::EKReactionImplIndexed(), walberla::EKReactionImplIndexed::get_node_is_boundary(), walberla::EKReactionImplIndexed::perform_reaction(), and walberla::EKReactionImplIndexed::set_node_is_boundary().

get_reactants()

auto const & walberla::EKReactionBase::get_reactants ( ) const

inlinenoexcept

Definition at line 55 of file EKReactionBase.hpp.

Referenced by walberla::EKReactionImplIndexed::perform_reaction().

perform_reaction()

virtual void walberla::EKReactionBase::perform_reaction ( )

pure virtual

Implemented in walberla::EKReactionImplBulk, and walberla::EKReactionImplIndexed.

set_coefficient()

void walberla::EKReactionBase::set_coefficient ( double  coefficient )

inlinenoexcept

Definition at line 48 of file EKReactionBase.hpp.

---

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

• EKReactionBase.hpp