KADATH
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Kadath::Ope_eq Class Referenceabstract
Equations management

Abstract class that describes the various operators that can appear in the equations. More...

#include <ope_eq.hpp>

Inheritance diagram for Kadath::Ope_eq:
Kadath::Ope_add Kadath::Ope_atanh Kadath::Ope_change_basis Kadath::Ope_conjug Kadath::Ope_cos Kadath::Ope_cosh Kadath::Ope_ddp Kadath::Ope_ddr Kadath::Ope_ddt Kadath::Ope_ddtime Kadath::Ope_def Kadath::Ope_def_global Kadath::Ope_der Kadath::Ope_der_background Kadath::Ope_der_flat Kadath::Ope_determinant Kadath::Ope_div Kadath::Ope_div_1mrsL Kadath::Ope_div_1mx2 Kadath::Ope_div_cost Kadath::Ope_div_r Kadath::Ope_div_rsint Kadath::Ope_div_sint Kadath::Ope_div_xpone Kadath::Ope_dn Kadath::Ope_dr Kadath::Ope_dt Kadath::Ope_dtime Kadath::Ope_exp Kadath::Ope_fit_waves Kadath::Ope_grad Kadath::Ope_id Kadath::Ope_import Kadath::Ope_int Kadath::Ope_int_volume Kadath::Ope_inverse Kadath::Ope_inverse_nodet Kadath::Ope_lap Kadath::Ope_lap2 Kadath::Ope_log Kadath::Ope_minus Kadath::Ope_mode Kadath::Ope_mult Kadath::Ope_mult_1mrsL Kadath::Ope_mult_r Kadath::Ope_mult_rsint Kadath::Ope_mult_sint Kadath::Ope_mult_x Kadath::Ope_partial Kadath::Ope_partial_var Kadath::Ope_point Kadath::Ope_pow Kadath::Ope_scal Kadath::Ope_sin Kadath::Ope_sinh Kadath::Ope_sqrt Kadath::Ope_sqrt_anti Kadath::Ope_sqrt_nonstd Kadath::Ope_srdr Kadath::Ope_sub Kadath::Ope_user Kadath::Ope_user_bin Kadath::Ope_val Kadath::Ope_val_mode Kadath::Ope_val_ori

Public Member Functions

virtual ~Ope_eq ()
 Destructor. More...
 
int get_dom () const
 
virtual Term_eq action () const =0
 Computes the action of the current Ope_eq using its various parts. More...
 

Protected Member Functions

 Ope_eq (const System_of_eqs *syst, int dom, int np=0)
 Constructor. More...
 
 Ope_eq (const Ope_eq &)=delete
 Copy constructor. More...
 

Protected Attributes

const System_of_eqs * syst
 The associated System_of_eqs. More...
 
int dom
 Index of the Domain where the operator is defined. More...
 
int n_ope
 Number of terms involved (2 for + for instance, only one for sqrt...) More...
 
MMPtr_array< Ope_eq > parts
 Pointers of the various parts of the current operator. More...
 

Detailed Description

Abstract class that describes the various operators that can appear in the equations.

It can not be instanciated and one must use the derived classes. It works at the Term_eq level (i.e. on a given Domain and using the dual quantities required by the automatic differentiation technique).

Definition at line 32 of file ope_eq.hpp.

Constructor & Destructor Documentation

◆ Ope_eq() [1/2]

Kadath::Ope_eq::Ope_eq ( const System_of_eqs *  syst,
int  dom,
int  np = 0 
)
inlineprotected

Constructor.

The various parts are uninitialized at this point.

Parameters
syst: the associated System_of_eqs.
dom: the index of the Domain.
np: number of terms.

Definition at line 62 of file ope_eq.hpp.

◆ Ope_eq() [2/2]

Kadath::Ope_eq::Ope_eq ( const Ope_eq &  )
protecteddelete

Copy constructor.

◆ ~Ope_eq()

Kadath::Ope_eq::~Ope_eq ( )
inlinevirtual

Destructor.

Definition at line 66 of file ope_eq.hpp.

References parts.

Member Function Documentation

◆ action()

virtual Term_eq Kadath::Ope_eq::action ( ) const
pure virtual

Computes the action of the current Ope_eq using its various parts.

Returns
the Term_eq containing the result.

Implemented in Kadath::Ope_conjug, Kadath::Ope_def_global, Kadath::Ope_change_basis, Kadath::Ope_import, Kadath::Ope_user_bin, Kadath::Ope_user, Kadath::Ope_fit_waves, Kadath::Ope_sin, Kadath::Ope_cos, Kadath::Ope_atanh, Kadath::Ope_sinh, Kadath::Ope_cosh, Kadath::Ope_log, Kadath::Ope_exp, Kadath::Ope_sqrt_nonstd, Kadath::Ope_sqrt_anti, Kadath::Ope_sqrt, Kadath::Ope_val_ori, Kadath::Ope_point, Kadath::Ope_val, Kadath::Ope_val_mode, Kadath::Ope_mode, Kadath::Ope_partial_var, Kadath::Ope_inverse_nodet, Kadath::Ope_inverse, Kadath::Ope_determinant, Kadath::Ope_partial, Kadath::Ope_div_sint, Kadath::Ope_mult_sint, Kadath::Ope_mult_1mrsL, Kadath::Ope_div_1mrsL, Kadath::Ope_div_1mx2, Kadath::Ope_div_xpone, Kadath::Ope_div_cost, Kadath::Ope_mult_rsint, Kadath::Ope_div_rsint, Kadath::Ope_div_r, Kadath::Ope_ddt, Kadath::Ope_dt, Kadath::Ope_ddp, Kadath::Ope_dr, Kadath::Ope_ddr, Kadath::Ope_srdr, Kadath::Ope_mult_x, Kadath::Ope_mult_r, Kadath::Ope_def, Kadath::Ope_int_volume, Kadath::Ope_int, Kadath::Ope_der_background, Kadath::Ope_der_flat, Kadath::Ope_der, Kadath::Ope_scal, Kadath::Ope_grad, Kadath::Ope_dn, Kadath::Ope_lap2, Kadath::Ope_ddtime, Kadath::Ope_dtime, Kadath::Ope_lap, Kadath::Ope_div, Kadath::Ope_mult, Kadath::Ope_sub, Kadath::Ope_add, Kadath::Ope_minus, Kadath::Ope_pow, and Kadath::Ope_id.

◆ get_dom()

int Kadath::Ope_eq::get_dom ( ) const
inline
Returns
the index of the Domain.

Definition at line 53 of file ope_eq.hpp.

References dom.

Member Data Documentation

◆ dom

int Kadath::Ope_eq::dom
protected

Index of the Domain where the operator is defined.

Definition at line 36 of file ope_eq.hpp.

◆ n_ope

int Kadath::Ope_eq::n_ope
protected

Number of terms involved (2 for + for instance, only one for sqrt...)

Definition at line 37 of file ope_eq.hpp.

◆ parts

MMPtr_array<Ope_eq> Kadath::Ope_eq::parts
protected

Pointers of the various parts of the current operator.

Definition at line 38 of file ope_eq.hpp.

◆ syst

const System_of_eqs* Kadath::Ope_eq::syst
protected

The associated System_of_eqs.

Definition at line 35 of file ope_eq.hpp.

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