Finite-difference array intended to store field values. More...

#include <tbl_val.h>

Public Member Functions
	Tbl_val (const Grille_val *)
	Constructor from a 3D grid. More...

	Tbl_val (const Grille_val , FILE )
	Constructor from a file (see `sauve(FILE*)` ) More...

	Tbl_val (const Tbl_val &)
	Copy constructor. More...

	~Tbl_val ()
	Destructor. More...

void	operator= (const Tbl_val &)
	Assignment to another `Tbl_val`. More...

void	operator= (double)
	Assignment to a `double`. More...

void	operator= (int)
	Assignment to a `int`. More...

void	set_etat_nondef ()
	Sets the logical state to `ETATNONDEF` (undefined). More...

void	set_etat_zero ()
	Sets the logical state to `ETATZERO` (zero). More...

void	set_etat_qcq ()
	Sets the logical state to `ETATQCQ` (ordinary state). More...

void	append_array (double *t_in)
	Appends an array of doubles as the main array `t` of `this` (DO NOT use it, unless you REALLY know how it works). More...

void	annule_hard ()
	Sets the `Tbl_val` to zero in a hard way. More...

double &	set (int i)
	Read/write of a particular element (index `i` ) (1D case) More...

double &	set_zri (int i)
	Read/write of a particular element on the interface (index `i` ) (1D case) More...

double	operator() (int i) const
	Read-only of a particular element (index `i` ) (1D case) More...

double	get_zri (int i) const
	Read-only of a particular element on the interface (index `i` ) (1D case) More...

double &	set (int j, int i)
	Read/write of a particular element (index (j,i) ) (2D case) More...

double &	set_xti (int j, int i)
	Read/write of a particular element on the x (or $\theta$ ) interface (index (j,i) ) (2D case) More...

double &	set_zri (int j, int i)
	Read/write of a particular element on the z (or r) interface (index (j,i) ) (2D case) More...

double	operator() (int j, int i) const
	Read-only of a particular element (index (j,i) ) (2D case) More...

double	get_xti (int j, int i) const
	Read-only of a particular element on the x (or $\theta$ ) interface (index (j,i) ) (2D case) More...

double	get_zri (int j, int i) const
	Read-only of a particular element on the z (or r) interface (index (j,i) ) (2D case) More...

double &	set (int k, int j, int i)
	Read/write of a particular element (index (k,j,i) ) (3D case) More...

double &	set_ypi (int k, int j, int i)
	Read/write of a particular element on the y (or $\phi$ ) interface (index (k,j,i) ) (3D case) More...

double &	set_xti (int k, int j, int i)
	Read/write of a particular element on the x (or $\theta$ ) interface (index (k,j,i) ) (3D case) More...

double &	set_zri (int k, int j, int i)
	Read/write of a particular element on the z (or r) interface (index (k,j,i) ) (3D case) More...

double	operator() (int k, int j, int i) const
	Read-only of a particular element (index (k,j,i) ) (3D case) More...

double	get_ypi (int k, int j, int i) const
	Read-only of a particular element on the y (or $\phi$ ) interface (index (k,j,i) ) (3D case) More...

double	get_xti (int k, int j, int i) const
	Read-only of a particular element on the x (or $\theta$ ) interface (index (k,j,i) ) (3D case) More...

double	get_zri (int k, int j, int i) const
	Read-only of a particular element on the z (or r) interface (index (k,j,i) ) (3D case) More...

int	get_etat () const
	Gives the logical state. More...

int	get_taille () const
	Gives the size of the node array (including the hidden cells) More...

int	get_taille_i (int i) const
	Gives the size of the interface arrays (including the hidden cells) More...

int	get_ndim () const
	Gives the number of dimensions (ie `dim->ndim` ) More...

int	get_dim (int i) const
	Gives the `i` th dimension (ie `dim->dim`[i] , without hidden cells) More...

const Grille_val *	get_grille () const
	Returns a pointer on the grid on which the `Tbl_val` is defined. More...

void	sauve (FILE *) const
	Save in a file. More...

void	affiche_seuil (ostream &ostr, int precision=4, double threshold=1.e-7) const
	Prints only the values greater than a given threshold. More...

void	operator+= (const Tbl_val &)
	Addition of a `Tbl_val` to `this`. More...

void	operator+= (double)
	Addition of a `double` to `this`. More...

void	operator-= (const Tbl_val &)
	Subtraction of a `Tbl_val` to `this`. More...

void	operator-= (double)
	Subtraction of a `double` to `this`. More...

void	operator*= (const Tbl_val &)
	Multiplication of `this` by a `Tbl_val`. More...

void	operator*= (double)
	Multiplication of `this` by a `double`. More...

void	operator/= (const Tbl_val &)
	Division of `this` by a `Tbl_val`. More...

void	operator/= (double)
	Division of `this` by a `double`. More...

Scalar	to_spectral (const Map &map, const int lmax, const int lmin=0, int type_inter=2) const
	Interpolation from a `Tbl_val` to a `Scalar` . More...

void	from_spectral (const Scalar &meudon, int lmax, int lmin=0, bool interfr=false, bool interft=false)
	Interpolation from a `Scalar` to a `Tbl_val` (spectral summation). More...

void	smooth_atmosphere (double atmosphere_thr)

Public Attributes
double *	t
	The array of `double` at the nodes. More...

double *	tzri
	The array at z (or r) interfaces. More...

double *	txti
	The array at x (or $\theta$ ) interfaces. More...

double *	typi
	The array at y (or $\phi$ ) interfaces. More...

Private Member Functions
void	del_t ()
	Logical destructor: dellocates the memory occupied by the array `t` and sets the logical state to ETATNONDEF. More...

Private Attributes
int	etat
	logical state (`ETATNONDEF` , `ETATQCQ` or `ETATZERO` ). More...

const Dim_tbl *	dim
	The `Dim_tbl` giving the dimensions and number of points (without the hidden cells). More...

const Grille_val *	gval
	The `Grille_val` (cartesian or spherical) on which the array is defined. More...

Friends
ostream &	operator<< (ostream &, const Tbl_val &)
	Display. More...

Detailed Description

Finite-difference array intended to store field values.

()

Class defined on a cartesian (Gval_cart ) or spherical (Gval_spher ) grid, in order to represent Godunov-type arrays in 1,2 or 3D.

Definition at line 97 of file tbl_val.h.

Constructor & Destructor Documentation

◆ Tbl_val() [1/3]

Lorene::Tbl_val::Tbl_val ( const Grille_val * g )

explicit

Constructor from a 3D grid.

Definition at line 86 of file tbl_val.C.

◆ Tbl_val() [2/3]

Lorene::Tbl_val::Tbl_val	(	const Grille_val *	g,
		FILE *	fd
	)

explicit

Constructor from a file (see sauve(FILE*) )

Definition at line 125 of file tbl_val.C.

References etat, and Lorene::fread_be().

◆ Tbl_val() [3/3]

Lorene::Tbl_val::Tbl_val ( const Tbl_val & tc )

Copy constructor.

Definition at line 90 of file tbl_val.C.

References etat.

◆ ~Tbl_val()

Lorene::Tbl_val::~Tbl_val ( )

Destructor.

Definition at line 157 of file tbl_val.C.

References del_t().

Member Function Documentation

◆ affiche_seuil()

void Lorene::Tbl_val::affiche_seuil	(	ostream &	ostr,
		int	precision = `4`,
		double	threshold = `1.e-7`
	)		const

Prints only the values greater than a given threshold.

Parameters

ostr	[input] Output stream used for the printing
precision	[input] Number of printed digits (default: 4)
threshold	[input] Value above which an array element is printed (default: 1.e-7)

Definition at line 432 of file tbl_val.C.

References etat, get_dim(), Lorene::Grille_val::get_fantome(), get_ndim(), get_taille(), and gval.

◆ annule_hard()

void Lorene::Tbl_val::annule_hard ( )

Sets the Tbl_val to zero in a hard way.

1/ Sets the logical state to ETATQCQ , i.e. to an ordinary state. 2/ Allocates the memory of the double array t , and fills it with zeros. NB: this function must be used for debugging purposes only. For other operations, the function set_etat_zero() must be perferred.

Definition at line 314 of file tbl_val.C.

References etat, get_ndim(), get_taille(), get_taille_i(), t, txti, typi, and tzri.

◆ append_array()

void Lorene::Tbl_val::append_array ( double * t_in )

Appends an array of doubles as the main array t of this (DO NOT use it, unless you REALLY know how it works).

Definition at line 339 of file tbl_val.C.

References del_t(), etat, and t.

◆ del_t()

void Lorene::Tbl_val::del_t ( )

private

Logical destructor: dellocates the memory occupied by the array t and sets the logical state to ETATNONDEF.

Definition at line 270 of file tbl_val.C.

References etat, t, txti, typi, and tzri.

◆ from_spectral()

void Lorene::Tbl_val::from_spectral	(	const Scalar &	meudon,
		int	lmax,
		int	lmin = `0`,
		bool	interfr = `false`,
		bool	interft = `false`
	)

Interpolation from a Scalar to a Tbl_val (spectral summation).

The Scalar is considered only in zones [lmin,lmax[.

Parameters

meudon	[input] The `Scalar` from which the interpolation is done
lmax	[input] index of the outer zone +1
lmin	[input] index of the inner zone

Definition at line 309 of file tbl_val_interp.C.

References Lorene::Scalar::get_etat().

◆ get_dim()

int Lorene::Tbl_val::get_dim ( int i ) const

inline

Gives the i th dimension (ie dim->dim[i] , without hidden cells)

Definition at line 485 of file tbl_val.h.

References Lorene::Dim_tbl::dim, and dim.

◆ get_etat()

int Lorene::Tbl_val::get_etat ( ) const

inline

Gives the logical state.

Definition at line 459 of file tbl_val.h.

References etat.

◆ get_grille()

const Grille_val* Lorene::Tbl_val::get_grille ( ) const

inline

Returns a pointer on the grid on which the Tbl_val is defined.

Definition at line 491 of file tbl_val.h.

References gval.

◆ get_ndim()

int Lorene::Tbl_val::get_ndim ( ) const

inline

Gives the number of dimensions (ie dim->ndim )

Definition at line 482 of file tbl_val.h.

References dim, and Lorene::Dim_tbl::ndim.

◆ get_taille()

int Lorene::Tbl_val::get_taille ( ) const

inline

Gives the size of the node array (including the hidden cells)

Definition at line 462 of file tbl_val.h.

References Lorene::Dim_tbl::dim, dim, Lorene::Grille_val::get_fantome(), gval, and Lorene::Dim_tbl::ndim.

◆ get_taille_i()

int Lorene::Tbl_val::get_taille_i ( int i ) const

inline

Gives the size of the interface arrays (including the hidden cells)

Definition at line 469 of file tbl_val.h.

References Lorene::Dim_tbl::dim, dim, Lorene::Grille_val::get_fantome(), gval, and Lorene::Dim_tbl::ndim.

◆ get_xti() [1/2]

double Lorene::Tbl_val::get_xti	(	int	j,
		int	i
	)		const

inline

Read-only of a particular element on the x (or $\theta$ ) interface (index (j,i) ) (2D case)

Definition at line 296 of file tbl_val.h.

References etat.

◆ get_xti() [2/2]

double Lorene::Tbl_val::get_xti	(	int	k,
		int	j,
		int	i
	)		const

inline

Read-only of a particular element on the x (or $\theta$ ) interface (index (k,j,i) ) (3D case)

Definition at line 422 of file tbl_val.h.

References etat.

◆ get_ypi()

double Lorene::Tbl_val::get_ypi	(	int	k,
		int	j,
		int	i
	)		const

inline

Read-only of a particular element on the y (or $\phi$ ) interface (index (k,j,i) ) (3D case)

Definition at line 403 of file tbl_val.h.

References etat.

◆ get_zri() [1/3]

double Lorene::Tbl_val::get_zri ( int i ) const

inline

Read-only of a particular element on the interface (index i ) (1D case)

Definition at line 229 of file tbl_val.h.

References etat.

◆ get_zri() [2/3]

double Lorene::Tbl_val::get_zri	(	int	j,
		int	i
	)		const

inline

Read-only of a particular element on the z (or r) interface (index (j,i) ) (2D case)

Definition at line 313 of file tbl_val.h.

References etat.

◆ get_zri() [3/3]

double Lorene::Tbl_val::get_zri	(	int	k,
		int	j,
		int	i
	)		const

inline

Read-only of a particular element on the z (or r) interface (index (k,j,i) ) (3D case)

Definition at line 441 of file tbl_val.h.

References etat.

◆ operator()() [1/3]

double Lorene::Tbl_val::operator() ( int i ) const

inline

Read-only of a particular element (index i ) (1D case)

Definition at line 215 of file tbl_val.h.

References etat.

◆ operator()() [2/3]

double Lorene::Tbl_val::operator()	(	int	j,
		int	i
	)		const

inline

Read-only of a particular element (index (j,i) ) (2D case)

Definition at line 279 of file tbl_val.h.

References etat.

◆ operator()() [3/3]

double Lorene::Tbl_val::operator()	(	int	k,
		int	j,
		int	i
	)		const

inline

Read-only of a particular element (index (k,j,i) ) (3D case)

Definition at line 384 of file tbl_val.h.

References etat.

◆ operator*=() [1/2]

void Lorene::Tbl_val::operator*= ( const Tbl_val & ti )

Multiplication of this by a Tbl_val.

Definition at line 794 of file arithm_tbl_val.C.

References etat, and gval.

◆ operator*=() [2/2]

void Lorene::Tbl_val::operator*= ( double x )

Multiplication of this by a double.

Definition at line 827 of file arithm_tbl_val.C.

References etat.

◆ operator+=() [1/2]

void Lorene::Tbl_val::operator+= ( const Tbl_val & ti )

Addition of a Tbl_val to this.

Definition at line 580 of file arithm_tbl_val.C.

References etat, and gval.

◆ operator+=() [2/2]

void Lorene::Tbl_val::operator+= ( double x )

Addition of a double to this.

Definition at line 634 of file arithm_tbl_val.C.

References etat.

◆ operator-=() [1/2]

void Lorene::Tbl_val::operator-= ( const Tbl_val & ti )

Subtraction of a Tbl_val to this.

Definition at line 686 of file arithm_tbl_val.C.

References etat, and gval.

◆ operator-=() [2/2]

void Lorene::Tbl_val::operator-= ( double x )

Subtraction of a double to this.

Definition at line 741 of file arithm_tbl_val.C.

References etat.

◆ operator/=() [1/2]

void Lorene::Tbl_val::operator/= ( const Tbl_val & ti )

Division of this by a Tbl_val.

Definition at line 858 of file arithm_tbl_val.C.

References etat, and gval.

◆ operator/=() [2/2]

void Lorene::Tbl_val::operator/= ( double x )

Division of this by a double.

Definition at line 893 of file arithm_tbl_val.C.

References etat.

◆ operator=() [1/3]

void Lorene::Tbl_val::operator= ( const Tbl_val & tx )

Assignment to another Tbl_val.

Definition at line 166 of file tbl_val.C.

References get_etat(), and gval.

◆ operator=() [2/3]

void Lorene::Tbl_val::operator= ( double a )

Assignment to a double.

Definition at line 199 of file tbl_val.C.

References get_taille(), get_taille_i(), set_etat_qcq(), set_etat_zero(), t, txti, typi, and tzri.

◆ operator=() [3/3]

void Lorene::Tbl_val::operator= ( int m )

Assignment to a int.

Definition at line 222 of file tbl_val.C.

References get_taille(), get_taille_i(), set_etat_qcq(), set_etat_zero(), t, txti, typi, and tzri.

◆ sauve()

void Lorene::Tbl_val::sauve ( FILE * fd ) const

Save in a file.

Definition at line 252 of file tbl_val.C.

References etat, and Lorene::fwrite_be().

◆ set() [1/3]

double& Lorene::Tbl_val::set ( int i )

inline

Read/write of a particular element (index i ) (1D case)

Definition at line 195 of file tbl_val.h.

References etat.

◆ set() [2/3]

double& Lorene::Tbl_val::set	(	int	j,
		int	i
	)

inline

Read/write of a particular element (index (j,i) ) (2D case)

Definition at line 243 of file tbl_val.h.

References etat.

◆ set() [3/3]

double& Lorene::Tbl_val::set	(	int	k,
		int	j,
		int	i
	)

inline

Read/write of a particular element (index (k,j,i) ) (3D case)

Definition at line 327 of file tbl_val.h.

References etat.

◆ set_etat_nondef()

void Lorene::Tbl_val::set_etat_nondef ( )

Sets the logical state to ETATNONDEF (undefined).

Deallocates the memory occupied by the double array t .

Definition at line 290 of file tbl_val.C.

References etat.

◆ set_etat_qcq()

void Lorene::Tbl_val::set_etat_qcq ( )

Sets the logical state to ETATQCQ (ordinary state).

If the state (member etat ) is already ETATQCQ , this function does nothing. Otherwise, it performs the memory allocation for the double array t .

Definition at line 297 of file tbl_val.C.

References etat.

◆ set_etat_zero()

void Lorene::Tbl_val::set_etat_zero ( )

Sets the logical state to ETATZERO (zero).

Deallocates the memory occupied by the double array t .

Definition at line 283 of file tbl_val.C.

References etat.

◆ set_xti() [1/2]

double& Lorene::Tbl_val::set_xti	(	int	j,
		int	i
	)

inline

Read/write of a particular element on the x (or $\theta$ ) interface (index (j,i) ) (2D case)

Definition at line 256 of file tbl_val.h.

References etat.

◆ set_xti() [2/2]

double& Lorene::Tbl_val::set_xti	(	int	k,
		int	j,
		int	i
	)

inline

Read/write of a particular element on the x (or $\theta$ ) interface (index (k,j,i) ) (3D case)

Definition at line 357 of file tbl_val.h.

References etat.

◆ set_ypi()

double& Lorene::Tbl_val::set_ypi	(	int	k,
		int	j,
		int	i
	)

inline

Read/write of a particular element on the y (or $\phi$ ) interface (index (k,j,i) ) (3D case)

Definition at line 342 of file tbl_val.h.

References etat.

◆ set_zri() [1/3]

double& Lorene::Tbl_val::set_zri ( int i )

inline

Read/write of a particular element on the interface (index i ) (1D case)

Definition at line 205 of file tbl_val.h.

References etat.

◆ set_zri() [2/3]

double& Lorene::Tbl_val::set_zri	(	int	j,
		int	i
	)

inline

Read/write of a particular element on the z (or r) interface (index (j,i) ) (2D case)

Definition at line 269 of file tbl_val.h.

References etat.

◆ set_zri() [3/3]

double& Lorene::Tbl_val::set_zri	(	int	k,
		int	j,
		int	i
	)

inline

Read/write of a particular element on the z (or r) interface (index (k,j,i) ) (3D case)

Definition at line 372 of file tbl_val.h.

References etat.

◆ to_spectral()

Scalar Lorene::Tbl_val::to_spectral	(	const Map &	map,
		const int	lmax,
		const int	lmin = `0`,
		int	type_inter = `2`
	)		const

Interpolation from a Tbl_val to a Scalar .

The Scalar is evaluated only in zones [lmin, lmax[.

Parameters

map	[input] The `Mapping` to which the `Tbl_val` is interpolated. The symetries of both grids must be the same (see `Mg3d` and `Grille_val` documentation), and the spectral grid (between lmin and lmax-1) must be included in the Godunov one. The number of points in $\theta$ and $\phi$ of the spectral grid may be different/domain. Still, the domain with the highest number of points in $\theta$ (resp. $\phi$ ) must contain the collocation points
lmax	[input] index of the outer zone +1
lmin	[input] index of the inner zone
type_inter	[input] type of interpolation: \ 0 -> uses the `INSMTS` routine of second derivative minimization\ 1 -> linear interpolation\ 2 -> parabolic interpolation\ 3 -> spline interpolation (not implemented yet)\

Returns: Scalar containing the value of the field at spectral collocation points.

Definition at line 97 of file tbl_val_interp.C.

References etat.

Friends And Related Function Documentation

◆ operator<<

ostream& operator<<	(	ostream &	o,
		const Tbl_val &	t
	)

friend

Display.

Definition at line 354 of file tbl_val.C.

Member Data Documentation

◆ dim

const Dim_tbl* Lorene::Tbl_val::dim

private

The Dim_tbl giving the dimensions and number of points (without the hidden cells).

Definition at line 108 of file tbl_val.h.

◆ etat

int Lorene::Tbl_val::etat

private

logical state (ETATNONDEF , ETATQCQ or ETATZERO ).

Definition at line 103 of file tbl_val.h.

◆ gval

const Grille_val* Lorene::Tbl_val::gval

private

The Grille_val (cartesian or spherical) on which the array is defined.

Definition at line 110 of file tbl_val.h.

◆ t

double* Lorene::Tbl_val::t

The array of double at the nodes.

Definition at line 114 of file tbl_val.h.

◆ txti

double* Lorene::Tbl_val::txti

The array at x (or $\theta$ ) interfaces.

Definition at line 118 of file tbl_val.h.

◆ typi

double* Lorene::Tbl_val::typi

The array at y (or $\phi$ ) interfaces.

Definition at line 120 of file tbl_val.h.

◆ tzri

double* Lorene::Tbl_val::tzri

The array at z (or r) interfaces.

Definition at line 116 of file tbl_val.h.

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Tbl_val() [1/3]

◆ Tbl_val() [2/3]

◆ Tbl_val() [3/3]

◆ ~Tbl_val()

Member Function Documentation

◆ affiche_seuil()

◆ annule_hard()

◆ append_array()

◆ del_t()

◆ from_spectral()

◆ get_dim()

◆ get_etat()

◆ get_grille()

◆ get_ndim()

◆ get_taille()

◆ get_taille_i()

◆ get_xti() [1/2]

◆ get_xti() [2/2]

◆ get_ypi()

◆ get_zri() [1/3]

◆ get_zri() [2/3]

◆ get_zri() [3/3]

◆ operator()() [1/3]

◆ operator()() [2/3]

◆ operator()() [3/3]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ sauve()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ set_etat_nondef()

◆ set_etat_qcq()

◆ set_etat_zero()

◆ set_xti() [1/2]

◆ set_xti() [2/2]

◆ set_ypi()

◆ set_zri() [1/3]

◆ set_zri() [2/3]

◆ set_zri() [3/3]

◆ to_spectral()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ dim

◆ etat

◆ gval

◆ t

◆ txti

◆ typi

◆ tzri