absorption::method< T, SAFE_MATH > Class Template Reference

Base class for absoption models. More...

#include <absorption.hpp>

Inheritance diagram for absorption::method< T, SAFE_MATH >:

Public Types
typedef T	base
	Type def to retrieve the backend base type.

Public Member Functions
virtual void	compile ()=0
	Compile the workitems.
virtual void	run (const size_t time_index)=0
	Run the workflow.

Static Public Attributes
static constexpr bool	safe_math = SAFE_MATH
	Retrieve template parameter of safe math.

Detailed Description

template<jit::complex_scalar T, bool SAFE_MATH = true>
class absorption::method< T, SAFE_MATH >

Base class for absoption models.

Template Parameters

T	Base type of the calculation.
SAFE_MATH	Use Safe Math operations.

Member Function Documentation

compile()

template<jit::complex_scalar T, bool SAFE_MATH = true>

virtual void absorption::method< T, SAFE_MATH >::compile ( )

pure virtual

Compile the workitems.

Implemented in absorption::root_finder< T, SAFE_MATH >, and absorption::weak_damping< T, SAFE_MATH >.

run()

template<jit::complex_scalar T, bool SAFE_MATH = true>

virtual void absorption::method< T, SAFE_MATH >::run ( const size_t  time_index )

pure virtual

Run the workflow.

Parameters

[in]

time_index

The time index to run the case for.

Implemented in absorption::root_finder< T, SAFE_MATH >, and absorption::weak_damping< T, SAFE_MATH >.

---

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

• graph_framework/absorption.hpp