SeldonData: SeldonData Namespace Reference


Classes
class	Data
	Data class. More...
class	Error
	Base class. More...
class	NoMemory
	No memory available. More...
class	WrongDim
	Wrong dimension. More...
class	WrongIndex
	Wrong index. More...
class	IOError
	An input/output operation failed. More...
class	Undefined
	Undefined function. More...
class	Format
	Base class for input/output classes. More...
class	FormatBinary
	Input/ouput class to read binary files. More...
class	FormatText
	Input/ouput class to read text files. More...
class	FormatFormattedText
	Input/ouput class to read formatted text files. More...
class	FormatNetCDF
	Input/ouput class to read netCDF files. More...
class	FormatGrib
	Input/ouput class to read Grib files. More...
class	FormatChimere
	Input/ouput class to read files in Chimere format. More...
class	Function_Base
	Based class for functions. More...
class	FuncCoords_Base
	Based class for coordinates transformations. More...
class	Grid
	Base class for grids. More...
class	RegularGrid
	Regular grids. More...
class	GeneralGrid
	General grids. More...
Functions
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationRegular (Data< TIn, N, TGIn > &dataIn, Data< TOut, N, TGOut > &dataOut)
	Linear interpolation for data defined on regular grids.
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationUniformToGeneral (Data< TIn, N, TGIn > &dataIn, Data< TOut, N, TGOut > &dataOut)
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationRegularToGeneral (Data< TIn, N, TGIn > &dataIn, Data< TOut, N, TGOut > &dataOut)
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationOneGeneral (Data< TIn, N, TGIn > &dataIn, Data< TOut, N, TGOut > &dataOut, int dim)
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationOneGeneralGetCoeffs (Data< TIn, N, TGIn > &dataIn, Data< TOut, N, TGOut > &dataOut, int dim, string FileName)
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationOneGeneralGetCoeffs (Data< TIn, N, TGIn > &dataIn, Data< TOut, N, TGOut > &dataOut, int dim, ofstream &FileStream)
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationOneGeneralGetCoeffs (Data< TIn, N, TGIn > &dataIn, Data< TOut, N, TGOut > &dataOut, int dim, Array< TIn, 2 > &RegularCoeffs, Array< TIn, 2 > &GeneralCoeffs, Array< int, 2 > &RegularIndices, Array< int, 2 > &GeneralIndices)
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationOneGeneralCompute (Data< TIn, N, TGIn > &dataIn, int dim, string FileName, Data< TOut, N, TGOut > &dataOut)
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationOneGeneralCompute (Data< TIn, N, TGIn > &dataIn, int dim, ifstream &FileStream, Data< TOut, N, TGOut > &dataOut)
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationOneGeneralCompute (Data< TIn, N, TGIn > &dataIn, int dim, Array< TIn, 2 > &RegularCoeffs, Array< TIn, 2 > &GeneralCoeffs, Array< int, 2 > &RegularIndices, Array< int, 2 > &GeneralIndices, Data< TOut, N, TGOut > &dataOut)
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationDimension (Data< TIn, N, TGIn > &dataIn, Data< TOut, N, TGOut > &dataOut, int dim)
	Linear interpolation along a given dimension.
template<int N, class TIn, class TGIn, class TOut, class TGOut>
void	LinearInterpolationPoint (Data< TIn, N, TGIn > &dataIn, Array< TGOut, 1 > &Coord, TOut &dataOut)
	Linear interpolation from data defined on regular grids to one point.

Detailed Description

Function Documentation

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationDimension	(	Data< TIn, N, TGIn > &	dataIn,
		Data< TOut, N, TGOut > &	dataOut,
		int	dim
	)

Linear interpolation along a given dimension.

Linear interpolation only along a given dimension.

Parameters:

	dataIn	reference data.
	dataOut	interpolated data (on exit).
	dim	dimension along which data should be interpolated.

Note:: 'dataIn' and 'dataOut' are assumed to be defined on the same grids except on the grid related to dimension 'dim'.

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationOneGeneral	(	Data< TIn, N, TGIn > &	dataIn,
		Data< TOut, N, TGOut > &	dataOut,
		int	dim
	)

Performs linear interpolation on data defined on regular grids, except one grid which may be a general grid (i.e. depending on other coordinates). Both input and output data may be defined on a general grid along dimension 'dim', but only along this dimension. Moreover, input data or output data can still be defined on regular grids along dimension 'dim'.

Parameters:

	dataIn	reference data.
	dataOut	interpolated data (on exit).
	dim	dimension related to the general grid.

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationOneGeneralCompute	(	Data< TIn, N, TGIn > &	dataIn,
		int	dim,
		Array< TIn, 2 > &	RegularCoeffs,
		Array< TIn, 2 > &	GeneralCoeffs,
		Array< int, 2 > &	RegularIndices,
		Array< int, 2 > &	GeneralIndices,
		Data< TOut, N, TGOut > &	dataOut
	)

Performs linear interpolation from data defined on regular grids, except one grid which may be a general grid. Input data may be defined on a general grid along dimension 'dim', but only along this dimension. Output data may be defined on general or regular grids. Moreover, input data can still be defined on regular grids along dimension 'dim'.

Parameters:

	dataIn	reference data.
	dim	dimension related to the general grid.
	RegularCoeffs	interpolation coefficients associated with regular grids.
	GeneralCoeffs	interpolation coefficients associated with the input general grid.
	RegularIndices	interpolation indices associated with regular grids.
	GeneralIndices	interpolation indices associated with the input general grid.
	dataOut	interpolated data (on exit).

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationOneGeneralCompute	(	Data< TIn, N, TGIn > &	dataIn,
		int	dim,
		ifstream &	FileStream,
		Data< TOut, N, TGOut > &	dataOut
	)

Parameters:

	dataIn	reference data.
	dim	dimension related to the general grid.
	FileStream	stream into which interpolation coefficients and indices are stored.
	dataOut	interpolated data (on exit).

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationOneGeneralCompute	(	Data< TIn, N, TGIn > &	dataIn,
		int	dim,
		string	FileName,
		Data< TOut, N, TGOut > &	dataOut
	)

Parameters:

	dataIn	reference data.
	dim	dimension related to the general grid.
	FileName	file into which interpolation coefficients and indices are stored.
	dataOut	interpolated data (on exit).

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationOneGeneralGetCoeffs	(	Data< TIn, N, TGIn > &	dataIn,
		Data< TOut, N, TGOut > &	dataOut,
		int	dim,
		Array< TIn, 2 > &	RegularCoeffs,
		Array< TIn, 2 > &	GeneralCoeffs,
		Array< int, 2 > &	RegularIndices,
		Array< int, 2 > &	GeneralIndices
	)

Saves indices and coefficients of linear interpolation from data defined on regular grids, except one grid which may be a general grid (i.e. depending on other coordinates). Input data may be defined on a general grid along dimension 'dim', but only along this dimension. Output data may be defined on general or regular grids. Moreover, input data can still be defined on regular grids along dimension 'dim'.

Parameters:

	dataIn	reference data.
	dataOut	interpolated data (on exit).
	dim	dimension related to the general grid.
	RegularCoeffs	interpolation coefficients associated with regular grids (on exit).
	GeneralCoeffs	interpolation coefficients associated with the input general grid (on exit).
	RegularIndices	interpolation indices associated with regular grids (on exit).
	GeneralIndices	interpolation indices associated with the input general grid (on exit).

Note:: dataOut is not modified. Interpolation oefficients and indices are just computed, not used for interpolation.

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationOneGeneralGetCoeffs	(	Data< TIn, N, TGIn > &	dataIn,
		Data< TOut, N, TGOut > &	dataOut,
		int	dim,
		ofstream &	FileStream
	)

Parameters:

	dataIn	reference data.
	dataOut	data to be interpolated.
	dim	dimension related to the general grid.
	FileStream	stream into which interpolation coefficients and indices are to be stored (on exit).

Note:: dataOut is not modified. Interpolation oefficients and indices are just computed, not used for interpolation.

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationOneGeneralGetCoeffs	(	Data< TIn, N, TGIn > &	dataIn,
		Data< TOut, N, TGOut > &	dataOut,
		int	dim,
		string	FileName
	)

Parameters:

	dataIn	reference data.
	dataOut	data to be interpolated.
	dim	dimension related to the general grid.
	FileName	file into which interpolation coefficients and indices are to be stored (on exit).

Note:: dataOut is not modified. Interpolation oefficients and indices are just computed, not used for interpolation.

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationPoint	(	Data< TIn, N, TGIn > &	dataIn,
		Array< TGOut, 1 > &	Coord,
		TOut &	dataOut
	)

Linear interpolation from data defined on regular grids to one point.

Linear interpolation from data defined on regular grids to data on one point.

Parameters:

	dataIn	reference data.
	Coord	coordinates of the interpolation point.

Returns:: data value on the interpolation point.

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationRegular	(	Data< TIn, N, TGIn > &	dataIn,
		Data< TOut, N, TGOut > &	dataOut
	)

Linear interpolation for data defined on regular grids.

Linear interpolation from data defined on regular grids to data defined on regular grids.

Parameters:

	dataIn	reference data.
	dataOut	interpolated data (on exit).

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationRegularToGeneral	(	Data< TIn, N, TGIn > &	dataIn,
		Data< TOut, N, TGOut > &	dataOut
	)

Parameters:

	dataIn	reference data defined on regular grids.
	dataOut	interpolated data (on exit) defined on any kind of grids.

template<int N, class TIn, class TGIn, class TOut, class TGOut>

void SeldonData::LinearInterpolationUniformToGeneral	(	Data< TIn, N, TGIn > &	dataIn,
		Data< TOut, N, TGOut > &	dataOut
	)

Linear interpolation from an input data defined on uniform grids only to an output data defined on any type of grids. Uniform grids are regular grids with fixed steps.

Parameters:

	dataIn	reference data defined on uniform grids.
	dataOut	interpolated data (on exit) defined on any type of grids.

SeldonData Namespace Reference

Classes

Functions

Detailed Description

Function Documentation