Lorene::Diff Class Referenceabstract

Base (abstract) class for 1D spectral differential operators in one domain. More...

#include <diff.h>

Inheritance diagram for Lorene::Diff:
Lorene::Diff_dsdx Lorene::Diff_dsdx2 Lorene::Diff_id Lorene::Diff_mx Lorene::Diff_mx2 Lorene::Diff_sx Lorene::Diff_sx2 Lorene::Diff_sxdsdx Lorene::Diff_x2dsdx Lorene::Diff_x2dsdx2 Lorene::Diff_x3dsdx Lorene::Diff_x3dsdx2 Lorene::Diff_x4dsdx2 Lorene::Diff_xdsdx Lorene::Diff_xdsdx2

Public Member Functions

int get_base () const
 Returns the base on which the operator is defined. More...
int get_npoints () const
 Returns the number of coefficients (size of the matrix) More...
 operator Matrice () const
 Conversion to a matrix. More...
virtual const Matriceget_matrice () const =0
 Returns the matrix associated with the operator. More...

Static Public Attributes

static const int max_points = 50
 Maximal number of matrices stored per base. More...

Protected Member Functions

 Diff (int base_r, int nr)
 Standard constructor. More...
 Diff (const Diff &)
 Copy constructor. More...
virtual ~Diff ()
 Destructor. More...
void operator= (const Diff &)
 Assignment to another Diff. More...
virtual ostream & operator>> (ostream &) const =0
 Operator >> (virtual function called by the operator <<). More...

Protected Attributes

int base
 Base in radial direction. More...
int npoints
 Number of coefficients. More...


ostream & operator<< (ostream &, const Diff &)
 Display. More...

Detailed Description

Base (abstract) class for 1D spectral differential operators in one domain.


This class is intended as a base class for several classes of elementary differential operators in term of $\xi$, in a given domain. Their main purpose is to compute the matrix of the elementary operator, for the given spectral base and number of coefficients. Some of the operators are not defined in the shells (division by $\xi$).

Definition at line 65 of file diff.h.

Constructor & Destructor Documentation

◆ Diff() [1/2]

Lorene::Diff::Diff ( int  base_r,
int  nr 

Standard constructor.

Definition at line 64 of file diff.C.

References base, and MAX_BASE.

◆ Diff() [2/2]

Lorene::Diff::Diff ( const Diff diff_in)

Copy constructor.

Definition at line 70 of file diff.C.

References base, and MAX_BASE.

◆ ~Diff()

Lorene::Diff::~Diff ( )


Definition at line 76 of file diff.C.

Member Function Documentation

◆ get_base()

int Lorene::Diff::get_base ( ) const

Returns the base on which the operator is defined.

Definition at line 96 of file diff.h.

References base.

◆ get_matrice()

◆ get_npoints()

int Lorene::Diff::get_npoints ( ) const

Returns the number of coefficients (size of the matrix)

Definition at line 99 of file diff.h.

References npoints.

◆ operator Matrice()

Lorene::Diff::operator Matrice ( ) const

Conversion to a matrix.

Definition at line 102 of file diff.h.

References get_matrice().

◆ operator=()

void Lorene::Diff::operator= ( const Diff diff_in)

Assignment to another Diff.

Definition at line 78 of file diff.C.

References base, MAX_BASE, and npoints.

◆ operator>>()

virtual ostream& Lorene::Diff::operator>> ( ostream &  ) const
protectedpure virtual

Friends And Related Function Documentation

◆ operator<<

ostream& operator<< ( ostream &  ost,
const Diff ope 


Definition at line 86 of file diff.C.

Member Data Documentation

◆ base

int Lorene::Diff::base

Base in radial direction.

Definition at line 74 of file diff.h.

◆ max_points

const int Lorene::Diff::max_points = 50

Maximal number of matrices stored per base.

Definition at line 71 of file diff.h.

◆ npoints

int Lorene::Diff::npoints

Number of coefficients.

Definition at line 75 of file diff.h.

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