LORENE
Public Member Functions | Protected Attributes | List of all members
Lorene::Change_var Class Reference
General PDE solvers (under development)

This class defines a variable change to be used when solving elliptic equations. More...

#include <change_var.h>

Public Member Functions

 Change_var (int var)
 Additive factor for F ## PROVISORY. More...
 
 Change_var (int var, double)
 Standard constructor. More...
 
 Change_var (int var, double, double)
 Standard constructor. More...
 
 Change_var (const Change_var &so)
 
 ~Change_var ()
 Constructor by copy. More...
 
double val_F (double x)
 Standard destructor. More...
 
double val_der_F (double x)
 Returns the value of $F$ at { x}. More...
 
double val_G (double x)
 Returns the value of $F'$ at { x}. More...
 
double val_der_G (double x)
 Returns the value of $G$ at { x}. More...
 

Protected Attributes

double(* func_F )(double)
 
double(* der_F )(double)
 Pointer on the function $F$. More...
 
double(* func_G )(double)
 Pointer on the derivative of $F$. More...
 
double(* der_G )(double)
 Pointer on the function $G$. More...
 
double mult_F
 Pointer on the derivative of $G$. More...
 
double add_F
 Multiplicative factor for F ## PROVISORY. More...
 

Detailed Description

This class defines a variable change to be used when solving elliptic equations.

In {one particular domain}, the change is defined as follows :()

$W = F\left(r\right) + G \left(r\right) w$

where $W$ is the usual variable, i.e. the one that is $\mathcal{C}^1$ and $w$ is the variable used for solving the elliptic equation. The functions $F$ and $G$ are arbitrary functions of $r$. The type of change must be explicitely implemented in the constructor for { Change_var}.

Definition at line 98 of file change_var.h.

Constructor & Destructor Documentation

◆ Change_var() [1/3]

Lorene::Change_var::Change_var ( int  var)

Additive factor for F ## PROVISORY.

Standard constructor. Case with without parameter. { var} defines explicitely the type of variable to be used. Are currently implemented : {itemize} { var} $= {\rm STD} \Longrightarrow F=0 \, \& \, G=1$. { var} $= {\rm W\_BETA} \Longrightarrow F=1 \, \& \, G = r$. { var} $= {\rm W\_BETA\_INF} \Longrightarrow F = 1+ \frac{1}{3}r^2\ln r \, \& \, G = r$. { var} $= {\rm H\_BETA} \Longrightarrow F=1 \, \&\, G=1$. { var} $= {\rm LAMBDA_RN} \Longrightarrow F=-\ln r \, \& \, G=1$. { var} $= {\rm NU_RN} \Longrightarrow F=\ln r \, \& \, G=1$. {itemize}

Definition at line 102 of file change_var.C.

References add_F, der_F, der_G, func_G, and mult_F.

◆ Change_var() [2/3]

Lorene::Change_var::Change_var ( int  var,
double  mult 
)

Standard constructor.

Case with one multiplicative parameter for F { var} defines explicitely the type of variable to be used.

Definition at line 160 of file change_var.C.

References add_F, der_F, der_G, func_G, and mult_F.

◆ Change_var() [3/3]

Lorene::Change_var::Change_var ( int  var,
double  mult,
double  add 
)

Standard constructor.

Case with one multiplicative parameter for F and one additive. { var} defines explicitely the type of variable to be used.

Definition at line 217 of file change_var.C.

References add_F, der_F, der_G, func_G, and mult_F.

◆ ~Change_var()

Lorene::Change_var::~Change_var ( )

Constructor by copy.

Definition at line 277 of file change_var.C.

Member Function Documentation

◆ val_der_F()

double Lorene::Change_var::val_der_F ( double  x)

Returns the value of $F$ at { x}.

Definition at line 283 of file change_var.C.

References der_F, and mult_F.

◆ val_der_G()

double Lorene::Change_var::val_der_G ( double  x)

Returns the value of $G$ at { x}.

Definition at line 291 of file change_var.C.

References der_G.

◆ val_F()

double Lorene::Change_var::val_F ( double  x)

Standard destructor.

Definition at line 279 of file change_var.C.

References add_F, and mult_F.

◆ val_G()

double Lorene::Change_var::val_G ( double  x)

Returns the value of $F'$ at { x}.

Definition at line 287 of file change_var.C.

References func_G.

Member Data Documentation

◆ add_F

double Lorene::Change_var::add_F
protected

Multiplicative factor for F ## PROVISORY.

Definition at line 107 of file change_var.h.

◆ der_F

double(* Lorene::Change_var::der_F) (double)
protected

Pointer on the function $F$.

Definition at line 102 of file change_var.h.

◆ der_G

double(* Lorene::Change_var::der_G) (double)
protected

Pointer on the function $G$.

Definition at line 104 of file change_var.h.

◆ func_G

double(* Lorene::Change_var::func_G) (double)
protected

Pointer on the derivative of $F$.

Definition at line 103 of file change_var.h.

◆ mult_F

double Lorene::Change_var::mult_F
protected

Pointer on the derivative of $G$.

Definition at line 106 of file change_var.h.

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