Graph Framework
Loading...
Searching...
No Matches
absorption::root_finder< T, SAFE_MATH > Class Template Reference

Class interface for the root finder. More...

#include <absorption.hpp>

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

Public Member Functions

 root_finder (graph::shared_leaf< T, SAFE_MATH > kamp, graph::shared_leaf< T, SAFE_MATH > w, graph::shared_leaf< T, SAFE_MATH > kx, graph::shared_leaf< T, SAFE_MATH > ky, graph::shared_leaf< T, SAFE_MATH > kz, graph::shared_leaf< T, SAFE_MATH > x, graph::shared_leaf< T, SAFE_MATH > y, graph::shared_leaf< T, SAFE_MATH > z, graph::shared_leaf< T, SAFE_MATH > t, equilibrium::shared< T, SAFE_MATH > &eq, const std::string &filename="", const size_t index=0)
 Constructor for root finding.
 ~root_finder ()
 Destructor.
void compile ()
 Compile the work items.
void run (const size_t time_index)
 Run the workflow.

Additional Inherited Members

Public Types inherited from absorption::method< T, true >
typedef T base
 Type def to retrieve the backend base type.
Static Public Attributes inherited from absorption::method< T, true >
static constexpr bool safe_math
 Retrieve template parameter of safe math.

Detailed Description

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

Class interface for the root finder.

Template Parameters
TBase type of the calculation.
SAFE_MATHUse Safe Math operations.

Constructor & Destructor Documentation

◆ root_finder()

template<jit::complex_scalar T, bool SAFE_MATH = true>
absorption::root_finder< T, SAFE_MATH >::root_finder ( graph::shared_leaf< T, SAFE_MATH > kamp,
graph::shared_leaf< T, SAFE_MATH > w,
graph::shared_leaf< T, SAFE_MATH > kx,
graph::shared_leaf< T, SAFE_MATH > ky,
graph::shared_leaf< T, SAFE_MATH > kz,
graph::shared_leaf< T, SAFE_MATH > x,
graph::shared_leaf< T, SAFE_MATH > y,
graph::shared_leaf< T, SAFE_MATH > z,
graph::shared_leaf< T, SAFE_MATH > t,
equilibrium::shared< T, SAFE_MATH > & eq,
const std::string & filename = "",
const size_t index = 0 )
inline

Constructor for root finding.

Parameters
[in]kampInitial kamp.
[in]wInitial w.
[in]kxInitial kx.
[in]kyInitial ky.
[in]kzInitial kz.
[in]xInitial x.
[in]yInitial y.
[in]zInitial z.
[in]tInitial t.
[in]eqThe plasma equilibrium.
[in]filenameResult filename, empty names will be blank.
[in]indexConcurrent index.

Member Function Documentation

◆ compile()

template<jit::complex_scalar T, bool SAFE_MATH = true>
void absorption::root_finder< T, SAFE_MATH >::compile ( )
inlinevirtual

Compile the work items.

Implements absorption::method< T, true >.

◆ run()

template<jit::complex_scalar T, bool SAFE_MATH = true>
void absorption::root_finder< T, SAFE_MATH >::run ( const size_t time_index)
inlinevirtual

Run the workflow.

Parameters
[in]time_indexThe time index to run the case for.

Implements absorption::method< T, true >.


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