ITHACAstream Namespace Reference

Namespace for input-output manipulation. More...

Functions
template<typename Type>
void	exportFvMatrix (fvMatrix< Type > &Matrix, word folder, word MatrixName)
	Export an Fv Matrix to folder together with its source term.
template<typename T, int dim>
void	exportMatrix (Eigen::Matrix< T, -1, dim > &matrix, word Name, word type="python", word folder="./Matrices")
	Export the reduced matrices in numpy (type=python), matlab (type=matlab) and txt (type=eigen) format The function is implemented for a second order matrix.
template void	exportMatrix (Eigen::Matrix< double, -1, -1 > &matrix, word Name, word type, word folder)
template void	exportMatrix (Eigen::Matrix< int, -1, -1 > &matrix, word Name, word type, word folder)
template void	exportMatrix (Eigen::Matrix< float, -1, -1 > &matrix, word Name, word type, word folder)
template void	exportMatrix (Eigen::Matrix< double, -1, 1 > &matrix, word Name, word type, word folder)
template void	exportMatrix (Eigen::Matrix< int, -1, 1 > &matrix, word Name, word type, word folder)
template void	exportMatrix (Eigen::Matrix< float, -1, 1 > &matrix, word Name, word type, word folder)
void	exportMatrix (List< Eigen::MatrixXd > &matrix, word Name, word type="python", word folder="./Matrices")
	Export the reduced matrices in numpy (type=python), matlab (type=matlab) and txt (type=eigen) format The function is implemented for a third order matrix The eigen matrix is stored as a set of two dimensional matrices where each matrix is in a different file.
void	exportVector (Eigen::VectorXd &vector, word Name, word type, word folder)
template<typename T>
void	exportTensor (Eigen::Tensor< T, 3 > tensor, word Name, word type="python", word folder="./Matrices")
	Export the reduced tensor in numpy (tipo=python), matlab (tipo=matlab) and txt (tipo=eigen) format.
template void	exportTensor (Eigen::Tensor< double, 3 > tensor, word Name, word type, word folder)
template void	exportTensor (Eigen::Tensor< int, 3 > tensor, word Name, word type, word folder)
template void	exportTensor (Eigen::Tensor< float, 3 > tensor, word Name, word type, word folder)
List< Eigen::MatrixXd >	readMatrix (word folder, word mat_name)
	Read a three dimensional matrix from a txt file in Eigen format.
Eigen::MatrixXd	readMatrix (word filename)
	Read a two dimensional matrix from a txt file in Eigen format.
template<class Type, template< class > class PatchField, class GeoMesh>
GeometricField< Type, PatchField, GeoMesh >	readFieldByIndex (const GeometricField< Type, PatchField, GeoMesh > &field, fileName casename, label index)
	Function to read a single field by index from a folder.
template<class Type, template< class > class PatchField, class GeoMesh>
void	read_fields (PtrList< GeometricField< Type, PatchField, GeoMesh > > &Lfield, word Name, fileName casename, int first_snap=0, int n_snap=0)
	Function to read a list of fields from the name of the field and casename.
template<class Type, template< class > class PatchField, class GeoMesh>
void	read_fields (PtrList< GeometricField< Type, PatchField, GeoMesh > > &Lfield, GeometricField< Type, PatchField, GeoMesh > &field, fileName casename, int first_snap=0, int n_snap=0)
	Function to read a list of fields from the name of the field if it is already existing.
template<class Type, template< class > class PatchField, class GeoMesh>
void	readMiddleFields (PtrList< GeometricField< Type, PatchField, GeoMesh > > &Lfield, GeometricField< Type, PatchField, GeoMesh > &field, fileName casename)
	Funtion to read a list of volVectorField from name of the field including all the intermediate snapshots.
template<class Type, template< class > class PatchField, class GeoMesh>
void	readConvergedFields (PtrList< GeometricField< Type, PatchField, GeoMesh > > &Lfield, GeometricField< Type, PatchField, GeoMesh > &field, fileName casename)
	Function to read a list of volVectorField from name of the field including only converged snapshots.
template<class Type, template< class > class PatchField, class GeoMesh>
void	read_last_fields (PtrList< GeometricField< Type, PatchField, GeoMesh > > &Lfield, const GeometricField< Type, PatchField, GeoMesh > &field, const fileName casename)
	Function to read a list of fields from the name of the field including only the last snapshot.
template<class Type, template< class > class PatchField, class GeoMesh>
void	readLastFields (PtrList< GeometricField< Type, PatchField, GeoMesh > > &Lfield, const GeometricField< Type, PatchField, GeoMesh > &field, const fileName casename)
	Funtion to read a list of volVectorField from name of the field including only the last snapshots.
int	numberOfFiles (word folder, word MatrixName, word ext="")
	Count the number of files with a certain name prefix, used by reading functions of list of matrices.
template<class Type, template< class > class PatchField, class GeoMesh>
void	exportFields (PtrList< GeometricField< Type, PatchField, GeoMesh > > &field, word folder, word fieldname)
	Function to export a scalar of vector field.
template void	exportFields (PtrList< GeometricField< scalar, fvPatchField, volMesh > > &field, word folder, word fieldname)
template void	exportFields (PtrList< GeometricField< scalar, fvsPatchField, surfaceMesh > > &field, word folder, word fieldname)
template void	exportFields (PtrList< GeometricField< vector, fvPatchField, volMesh > > &field, word folder, word fieldname)
template void	exportFields (PtrList< GeometricField< tensor, fvPatchField, volMesh > > &field, word folder, word fieldname)
template void	exportFields (PtrList< GeometricField< vector, pointPatchField, pointMesh > > &field, word folder, word fieldname)
template<class Type, template< class > class PatchField, class GeoMesh>
void	exportSolution (GeometricField< Type, PatchField, GeoMesh > &s, fileName subfolder, fileName folder, word fieldName)
	Export a field to file in a certain folder and subfolder.
template void	exportSolution (GeometricField< scalar, fvPatchField, volMesh > &s, fileName subfolder, fileName folder, word fieldName)
template void	exportSolution (GeometricField< vector, fvPatchField, volMesh > &s, fileName subfolder, fileName folder, word fieldName)
template void	exportSolution (GeometricField< tensor, fvPatchField, volMesh > &s, fileName subfolder, fileName folder, word fieldName)
template void	exportSolution (GeometricField< scalar, fvsPatchField, surfaceMesh > &s, fileName subfolder, fileName folder, word fieldName)
template void	exportSolution (GeometricField< vector, fvsPatchField, surfaceMesh > &s, fileName subfolder, fileName folder, word fieldName)
template<class Type, template< class > class PatchField, class GeoMesh>
void	exportSolution (GeometricField< Type, PatchField, GeoMesh > &s, fileName subfolder, fileName folder)
	Export a field to file in a certain folder and subfolder.
template void	exportSolution (GeometricField< scalar, fvPatchField, volMesh > &s, fileName subfolder, fileName folder)
template void	exportSolution (GeometricField< vector, fvPatchField, volMesh > &s, fileName subfolder, fileName folder)
template void	exportSolution (GeometricField< tensor, fvPatchField, volMesh > &s, fileName subfolder, fileName folder)
template void	exportSolution (GeometricField< scalar, fvsPatchField, surfaceMesh > &s, fileName subfolder, fileName folder)
template void	exportSolution (GeometricField< vector, fvsPatchField, surfaceMesh > &s, fileName subfolder, fileName folder)
template void	exportSolution (GeometricField< scalar, pointPatchField, pointMesh > &s, fileName subfolder, fileName folder)
template void	exportSolution (GeometricField< vector, pointPatchField, pointMesh > &s, fileName subfolder, fileName folder)
template void	exportSolution (GeometricField< tensor, pointPatchField, pointMesh > &s, fileName subfolder, fileName folder)
void	writePoints (pointField points, fileName folder, fileName subfolder)
	Write points of a mesh to a file.
void	printProgress (double percentage)
	Print progress bar given the percentage.
template<typename T>
void	save (const List< Eigen::SparseMatrix< T > > &MatrixList, word folder, word MatrixName)
template<typename T>
void	load (List< Eigen::SparseMatrix< T > > &MatrixList, word folder, word MatrixName)
template void	read_fields (PtrList< pointVectorField > &Lfield, word Name, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< pointVectorField > &Lfield, pointVectorField &field, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< volScalarField > &Lfield, word Name, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< volVectorField > &Lfield, word Name, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< volTensorField > &Lfield, word Name, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< surfaceScalarField > &Lfield, word Name, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< surfaceVectorField > &Lfield, word Name, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< volScalarField > &Lfield, volScalarField &field, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< volVectorField > &Lfield, volVectorField &field, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< volTensorField > &Lfield, volTensorField &field, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< surfaceScalarField > &Lfield, surfaceScalarField &field, fileName casename, int first_snap, int n_snap)
template void	read_fields (PtrList< surfaceVectorField > &Lfield, surfaceVectorField &field, fileName casename, int first_snap, int n_snap)
template void	readMiddleFields (PtrList< volScalarField > &Lfield, volScalarField &field, fileName casename)
template void	readMiddleFields (PtrList< pointVectorField > &Lfield, pointVectorField &field, fileName casename)
template void	readMiddleFields (PtrList< volVectorField > &Lfield, volVectorField &field, fileName casename)
template void	readMiddleFields (PtrList< volTensorField > &Lfield, volTensorField &field, fileName casename)
template void	readMiddleFields (PtrList< surfaceScalarField > &Lfield, surfaceScalarField &field, fileName casename)
template void	readMiddleFields (PtrList< surfaceVectorField > &Lfield, surfaceVectorField &field, fileName casename)
template void	readConvergedFields (PtrList< volScalarField > &Lfield, volScalarField &field, fileName casename)
template void	readConvergedFields (PtrList< volVectorField > &Lfield, volVectorField &field, fileName casename)
template void	readConvergedFields (PtrList< volTensorField > &Lfield, volTensorField &field, fileName casename)
template void	readConvergedFields (PtrList< surfaceScalarField > &Lfield, surfaceScalarField &field, fileName casename)
template void	readConvergedFields (PtrList< surfaceVectorField > &Lfield, surfaceVectorField &field, fileName casename)
template void	read_last_fields (PtrList< volScalarField > &Lfield, const volScalarField &field, const fileName casename)
template void	read_last_fields (PtrList< volVectorField > &Lfield, const volVectorField &field, const fileName casename)
template void	read_last_fields (PtrList< volTensorField > &Lfield, const volTensorField &field, const fileName casename)
template void	read_last_fields (PtrList< surfaceScalarField > &Lfield, const surfaceScalarField &field, const fileName casename)
template void	read_last_fields (PtrList< surfaceVectorField > &Lfield, const surfaceVectorField &field, const fileName casename)
template void	readLastFields (PtrList< volScalarField > &Lfield, const volScalarField &field, const fileName casename)
template void	readLastFields (PtrList< volVectorField > &Lfield, const volVectorField &field, const fileName casename)
template void	readLastFields (PtrList< volTensorField > &Lfield, const volTensorField &field, const fileName casename)
template void	readLastFields (PtrList< surfaceScalarField > &Lfield, const surfaceScalarField &field, const fileName casename)
template void	readLastFields (PtrList< surfaceVectorField > &Lfield, const surfaceVectorField &field, const fileName casename)
template<typename T>
void	exportList (T &list, word folder, word filename)
	Export a list to file.
template void	exportList (Field< scalar > &list, word folder, word filename)
template void	exportList (Field< vector > &list, word folder, word filename)
template void	exportList (Field< tensor > &list, word folder, word filename)
template void	save (const List< Eigen::SparseMatrix< double > > &MatrixList, word folder, word MatrixName)
template void	load (List< Eigen::SparseMatrix< double > > &MatrixList, word folder, word MatrixName)
template GeometricField< scalar, fvPatchField, volMesh >	readFieldByIndex (const GeometricField< scalar, fvPatchField, volMesh > &, fileName, label)
template GeometricField< vector, fvPatchField, volMesh >	readFieldByIndex (const GeometricField< vector, fvPatchField, volMesh > &, fileName, label)
template GeometricField< tensor, fvPatchField, volMesh >	readFieldByIndex (const GeometricField< tensor, fvPatchField, volMesh > &, fileName, label)
template GeometricField< scalar, fvsPatchField, surfaceMesh >	readFieldByIndex (const GeometricField< scalar, fvsPatchField, surfaceMesh > &, fileName, label)
template GeometricField< vector, fvsPatchField, surfaceMesh >	readFieldByIndex (const GeometricField< vector, fvsPatchField, surfaceMesh > &, fileName, label)
template<typename T>
void	read_snapshot (T &snapshot, const Foam::word snap_time, Foam::word path, Foam::word name)
template void	read_snapshot (Foam::volScalarField &snapshot, const Foam::word snap_time, Foam::word path, Foam::word name)
template void	read_snapshot (Foam::volVectorField &snapshot, const Foam::word snap_time, Foam::word path, Foam::word name)
template void	read_snapshot (Foam::volTensorField &snapshot, const Foam::word snap_time, Foam::word path, Foam::word name)
template<typename T, int Nrows, typename IND>
void	SaveSparseMatrix (Eigen::SparseMatrix< T, Nrows, IND > &m, word folder, word MatrixName)
	Export an Eigen sparse matrix into bynary format file.
template<typename T, int Nrows, typename IND>
void	ReadSparseMatrix (Eigen::SparseMatrix< T, Nrows, IND > &m, word folder, word MatrixName)
	Read an Eigen sparse matrix from a bynary format file.
template<typename MatrixType>
void	SaveDenseMatrix (MatrixType &Matrix, word folder, word MatrixName)
	Save a dense matrix to a binary format file.
template<typename MatrixType>
void	ReadDenseMatrix (MatrixType &Matrix, word folder, word MatrixName)
	Read a dense matrix from a binary format file.
template<typename TensorType>
void	SaveDenseTensor (TensorType &Tensor, word folder, word MatrixName)
	Save a dense tensor to file.
template<typename TensorType>
void	ReadDenseTensor (TensorType &Tensor, word folder, word MatrixName)
	Read a dense tensor from file.
template<typename MatrixType>
void	SaveSparseMatrixList (List< MatrixType > &MatrixList, word folder, word MatrixName)
	Save a sparse matrix list to bynary files.
template<typename T, int Nrows, typename IND>
void	ReadSparseMatrixList (List< Eigen::SparseMatrix< T, Nrows, IND > > &m, word folder, word MatrixName)
	Read a sparse matrix list to bynary files.
template<typename MatrixType>
void	SaveDenseMatrixList (List< MatrixType > &MatrixList, word folder, word MatrixName)
	Save a dense matrix list to bynary files.
template<typename MatrixType>
void	ReadDenseMatrixList (List< MatrixType > &m, word folder, word MatrixName)
	Read a sparse matrix list to bynary files.

Detailed Description

Namespace for input-output manipulation.

Function Documentation

exportFields()

template<class Type, template< class > class PatchField, class GeoMesh>

void ITHACAstream::exportFields	(	PtrList< GeometricField< Type, PatchField, GeoMesh > > &	field,
		word	folder,
		word	fieldname )

Function to export a scalar of vector field.

Parameters

[in]	field	The field you want to export.
[in]	folder	The folder where you want to save the field.
[in]	fieldname	The name you want to give to the file.

Template Parameters

Type	vector or scalar.
PatchField	fvPatchField or fvsPatchField.
GeoMesh	volMesh or surfaceMesh.

Definition at line 958 of file ITHACAstream.C.

exportFvMatrix()

template<typename Type>

void ITHACAstream::exportFvMatrix	(	fvMatrix< Type > &	Matrix,
		word	folder,
		word	MatrixName )

Export an Fv Matrix to folder together with its source term.

Parameters

	Matrix	The matrix
[in]	folder	The folder
[in]	MatrixName	The fieldname

Template Parameters

Type	can be scalar or vector

Definition at line 44 of file ITHACAstream.C.

exportList()

template<typename T>

void ITHACAstream::exportList	(	T &	list,
		word	folder,
		word	filename )

Export a list to file.

Parameters

[in]	list	The list
[in]	filename	Name of saved file
[in]	folder	Folder where the field is stored

Template Parameters

T	generic list type object

Definition at line 1240 of file ITHACAstream.C.

exportMatrix() [1/2]

template<typename T, int dim>

void ITHACAstream::exportMatrix	(	Eigen::Matrix< T, -1, dim > &	matrix,
		word	Name,
		word	type = "python",
		word	folder = "./Matrices" )

Export the reduced matrices in numpy (type=python), matlab (type=matlab) and txt (type=eigen) format The function is implemented for a second order matrix.

Parameters

[in]	matrix	Eigen::MatrixXd that you want to export.
[in]	Name	Name of saved file.
[in]	type	Format of the file: numpy (type="python"), matlab (type="matlab"), txt (type="eigen").
[in]	folder	Directory in which the file is saved.

Template Parameters

T	The matrix can be of integers, double or float

Definition at line 55 of file ITHACAstream.C.

exportMatrix() [2/2]

void ITHACAstream::exportMatrix	(	List< Eigen::MatrixXd > &	matrix,
		word	Name,
		word	type = "python",
		word	folder = "./Matrices" )

Export the reduced matrices in numpy (type=python), matlab (type=matlab) and txt (type=eigen) format The function is implemented for a third order matrix The eigen matrix is stored as a set of two dimensional matrices where each matrix is in a different file.

Parameters

[in]	matrix	Eigen::MatrixXd that you want to export.
[in]	Name	Name of saved file.
[in]	type	Format of the file: numpy (type="python"), matlab (type="matlab"), txt (type="eigen").
[in]	folder	Directory in which the file is saved.

Definition at line 173 of file ITHACAstream.C.

exportSolution() [1/2]

template<class Type, template< class > class PatchField, class GeoMesh>

void ITHACAstream::exportSolution	(	GeometricField< Type, PatchField, GeoMesh > &	s,
		fileName	subfolder,
		fileName	folder )

Export a field to file in a certain folder and subfolder.

Parameters

[in]	s	Field
[in]	subfolder	Subfolder where the field is stored
[in]	folder	Folder where the field is stored

Template Parameters

Type	vector or scalar.
PatchField	fvPatchField or fvsPatchField.
GeoMesh	volMesh or surfaceMesh.

Definition at line 1041 of file ITHACAstream.C.

exportSolution() [2/2]

template<class Type, template< class > class PatchField, class GeoMesh>

void ITHACAstream::exportSolution	(	GeometricField< Type, PatchField, GeoMesh > &	s,
		fileName	subfolder,
		fileName	folder,
		word	fieldName )

Export a field to file in a certain folder and subfolder.

Parameters

[in]	s	Field
[in]	subfolder	Subfolder where the field is stored
[in]	folder	Folder where the field is stored
[in]	fieldName	Name of the field/file

Template Parameters

Type	vector or scalar.
PatchField	fvPatchField or fvsPatchField.
GeoMesh	volMesh or surfaceMesh.

Definition at line 992 of file ITHACAstream.C.

exportTensor()

template<typename T>

void ITHACAstream::exportTensor	(	Eigen::Tensor< T, 3 >	tensor,
		word	Name,
		word	type = "python",
		word	folder = "./Matrices" )

Export the reduced tensor in numpy (tipo=python), matlab (tipo=matlab) and txt (tipo=eigen) format.

Parameters

[in]	tensor	The tensor that you want to export.
[in]	Name	Name of saved file.
[in]	type	Format of the file: numpy (type="python"), matlab (type="matlab"), txt (type="eigen").
[in]	folder	Directory in which the file is saved.
[in]	folder	folder string to identify the folder where you want to save the file.

Template Parameters

T	The tensor can be of integers, double or float

Definition at line 264 of file ITHACAstream.C.

exportVector()

void ITHACAstream::exportVector	(	Eigen::VectorXd &	vector,
		word	Name,
		word	type,
		word	folder )

Definition at line 255 of file ITHACAstream.C.

load()

template<typename T>

void ITHACAstream::load	(	List< Eigen::SparseMatrix< T > > &	MatrixList,
		word	folder,
		word	MatrixName )

Definition at line 1145 of file ITHACAstream.C.

numberOfFiles()

int ITHACAstream::numberOfFiles	(	word	folder,
		word	MatrixName,
		word	ext = "" )

Count the number of files with a certain name prefix, used by reading functions of list of matrices.

Parameters

[in]	folder	The folder
[in]	MatrixName	The matrix name

Returns

Number of files matching the request

Definition at line 937 of file ITHACAstream.C.

printProgress()

void ITHACAstream::printProgress

(

double

percentage

)

Print progress bar given the percentage.

Parameters

[in]

percentage

The percentage

Definition at line 1118 of file ITHACAstream.C.

read_fields() [1/2]

template<class Type, template< class > class PatchField, class GeoMesh>

void ITHACAstream::read_fields	(	PtrList< GeometricField< Type, PatchField, GeoMesh > > &	Lfield,
		GeometricField< Type, PatchField, GeoMesh > &	field,
		fileName	casename,
		int	first_snap = 0,
		int	n_snap = 0 )

Function to read a list of fields from the name of the field if it is already existing.

Parameters

[in]	Lfield	a PtrList of OpenFOAM fields where you want to store the field.
[in]	field	The field used as template to read other fields.
[in]	casename	The folder where the field is stored.
[in]	first_snap	The first snapshots from which you want to start reading the field.
[in]	n_snap	The number of snapshots you want to read.

Template Parameters

Type	vector or scalar.
PatchField	fvPatchField or fvsPatchField.
GeoMesh	volMesh or surfaceMesh.

Definition at line 658 of file ITHACAstream.C.

read_fields() [2/2]

template<class Type, template< class > class PatchField, class GeoMesh>

void ITHACAstream::read_fields	(	PtrList< GeometricField< Type, PatchField, GeoMesh > > &	Lfield,
		word	Name,
		fileName	casename,
		int	first_snap = 0,
		int	n_snap = 0 )

Function to read a list of fields from the name of the field and casename.

Parameters

[in]	Lfield	a PtrList of OpenFOAM fields where you want to store the field.
[in]	Name	The name of the field you want to read.
[in]	casename	The folder where the field is stored.
[in]	first_snap	The first snapshots from which you want to start reading the field.
[in]	n_snap	The number of snapshots you want to read.

Template Parameters

Type	vector or scalar.
PatchField	fvPatchField or fvsPatchField.
GeoMesh	volMesh or surfaceMesh.

Definition at line 517 of file ITHACAstream.C.

read_last_fields()

template<class Type, template< class > class PatchField, class GeoMesh>

void ITHACAstream::read_last_fields	(	PtrList< GeometricField< Type, PatchField, GeoMesh > > &	Lfield,
		const GeometricField< Type, PatchField, GeoMesh > &	field,
		const fileName	casename )

Function to read a list of fields from the name of the field including only the last snapshot.

Parameters

[in]	Lfield	a PtrList of OpenFOAM fields where you want to store the field.
[in]	field	The field used as template to read other fields.
[in]	casename	The folder where the field is stored.

Template Parameters

Type	vector or scalar.
PatchField	fvPatchField or fvsPatchField.
GeoMesh	volMesh or surfaceMesh.

Definition at line 837 of file ITHACAstream.C.

read_snapshot()

template<typename T>

void ITHACAstream::read_snapshot	(	T &	snapshot,
		const Foam::word	snap_time,
		Foam::word	path,
		Foam::word	name )

Definition at line 1298 of file ITHACAstream.C.

readConvergedFields()

template<class Type, template< class > class PatchField, class GeoMesh>

void ITHACAstream::readConvergedFields	(	PtrList< GeometricField< Type, PatchField, GeoMesh > > &	Lfield,
		GeometricField< Type, PatchField, GeoMesh > &	field,
		fileName	casename )

Function to read a list of volVectorField from name of the field including only converged snapshots.

Parameters

[in]	Lfield	a PtrList of OpenFOAM fields where you want to store the field.
[in]	field	The field used as template to read other fields.
[in]	casename	The folder where the field is stored.

Template Parameters

Type	vector or scalar.
PatchField	fvPatchField or fvsPatchField.
GeoMesh	volMesh or surfaceMesh.

Definition at line 801 of file ITHACAstream.C.

ReadDenseMatrix()

template<typename MatrixType>

void ITHACAstream::ReadDenseMatrix	(	MatrixType &	Matrix,
		word	folder,
		word	MatrixName )

Read a dense matrix from a binary format file.

Parameters

[in,out]	Matrix	Eigen dense matrix
[in]	folder	Folder from where you want to read the matrix
[in]	MatrixName	Name of the input file

Template Parameters

MatrixType

type of the matrix, i.e. double, float, ...

Definition at line 740 of file ITHACAstream.H.

ReadDenseMatrixList()

template<typename MatrixType>

void ITHACAstream::ReadDenseMatrixList	(	List< MatrixType > &	m,
		word	folder,
		word	MatrixName )

Read a sparse matrix list to bynary files.

Parameters

[in,out]	MatrixList	The matrix list
[in]	folder	The folder from where you want to read the files
[in]	MatrixName	The matrix name prefix, files are the named with an incremental number

Template Parameters

MatrixType

MatrixType type of the matrix, i.e. double, float, ...

Definition at line 850 of file ITHACAstream.H.

ReadDenseTensor()

template<typename TensorType>

void ITHACAstream::ReadDenseTensor	(	TensorType &	Tensor,
		word	folder,
		word	MatrixName )

Read a dense tensor from file.

Parameters

	[in/out]	Tensor The tensor
[in]	folder	Folder where you want to read the tensor
[in]	MatrixName	The matrix name

Template Parameters

TensorType

type of the tensor, i.e. double, float, ...

Definition at line 787 of file ITHACAstream.H.

readFieldByIndex()

template<class Type, template< class > class PatchField, class GeoMesh>

GeometricField< Type, PatchField, GeoMesh > ITHACAstream::readFieldByIndex	(	const GeometricField< Type, PatchField, GeoMesh > &	field,
		fileName	casename,
		label	index )

Function to read a single field by index from a folder.

Parameters

[in]	field	The field template to use for reading
[in]	casename	The folder where the field is stored
[in]	index	The index of the field to read

Returns

The read field

Template Parameters

Type	vector or scalar
PatchField	fvPatchField or fvsPatchField
GeoMesh	volMesh or surfaceMesh

Definition at line 454 of file ITHACAstream.C.

readLastFields()

template<class Type, template< class > class PatchField, class GeoMesh>

void ITHACAstream::readLastFields	(	PtrList< GeometricField< Type, PatchField, GeoMesh > > &	Lfield,
		const GeometricField< Type, PatchField, GeoMesh > &	field,
		const fileName	casename )

Funtion to read a list of volVectorField from name of the field including only the last snapshots.

Parameters

[in]	Lfield	a PtrList of OpenFOAM fields where you want to store the field.
[in]	field	The field used as template to read other fields.
[in]	casename	The folder where the field is stored.

Template Parameters

Type	vector or scalar.
PatchField	fvPatchField or fvsPatchField.
GeoMesh	volMesh or surfaceMesh.

Definition at line 921 of file ITHACAstream.C.

readMatrix() [1/2]

Eigen::MatrixXd ITHACAstream::readMatrix

(

word

filename

)

Read a two dimensional matrix from a txt file in Eigen format.

Parameters

[in]

filename

The filename of the matrix.

Returns

The Eigen::MatrixXd that contains the imported matrix.

Definition at line 400 of file ITHACAstream.C.

readMatrix() [2/2]

List< Eigen::MatrixXd > ITHACAstream::readMatrix	(	word	folder,
		word	mat_name )

Read a three dimensional matrix from a txt file in Eigen format.

Parameters

[in]	folder	The folder where the txt files are located
[in]	mat_name	The matrix name

Returns

List <Eigen::MatrixXd> that contains the imported matrix.

Definition at line 372 of file ITHACAstream.C.

readMiddleFields()

template<class Type, template< class > class PatchField, class GeoMesh>

void ITHACAstream::readMiddleFields	(	PtrList< GeometricField< Type, PatchField, GeoMesh > > &	Lfield,
		GeometricField< Type, PatchField, GeoMesh > &	field,
		fileName	casename )

Funtion to read a list of volVectorField from name of the field including all the intermediate snapshots.

Parameters

[in]	Lfield	a PtrList of OpenFOAM fields where you want to store the field.
[in]	field	The field used as template to read other fields.
[in]	casename	The folder where the field is stored.

Template Parameters

Type	vector or scalar.
PatchField	fvPatchField or fvsPatchField.
GeoMesh	volMesh or surfaceMesh.

Definition at line 785 of file ITHACAstream.C.

ReadSparseMatrix()

template<typename T, int Nrows, typename IND>

void ITHACAstream::ReadSparseMatrix	(	Eigen::SparseMatrix< T, Nrows, IND > &	m,
		word	folder,
		word	MatrixName )

Read an Eigen sparse matrix from a bynary format file.

Parameters

[in,out]	m	Eigen::SparseMatrix m
[in]	folder	The folder from where you want to read the matrix
[in]	MatrixName	The matrix name for the input file

Template Parameters

T	type of the matrix, i.e. double, float, ...
Nrows	number of matrix rows
IND	number of matrix cols

ReadSparseMatrixList()

template<typename T, int Nrows, typename IND>

void ITHACAstream::ReadSparseMatrixList	(	List< Eigen::SparseMatrix< T, Nrows, IND > > &	m,
		word	folder,
		word	MatrixName )

Read a sparse matrix list to bynary files.

Parameters

[in,out]	MatrixList	The matrix list
[in]	folder	The folder from where you want to read the files
[in]	MatrixName	The matrix name prefix, files are the named with an incremental number

Template Parameters

MatrixType	MatrixType type of the matrix, i.e. double, float, ...
Nrows	number of matrix rows
IND	number of matrix cols

save()

template<typename T>

void ITHACAstream::save	(	const List< Eigen::SparseMatrix< T > > &	MatrixList,
		word	folder,
		word	MatrixName )

Definition at line 1132 of file ITHACAstream.C.

SaveDenseMatrix()

template<typename MatrixType>

void ITHACAstream::SaveDenseMatrix	(	MatrixType &	Matrix,
		word	folder,
		word	MatrixName )

Save a dense matrix to a binary format file.

Parameters

[in]	Matrix	Eigen dense matrix
[in]	folder	Folder where you want to save the matrix
[in]	MatrixName	Name of the output file

Template Parameters

MatrixType

type of the matrix, i.e. double, float, ...

Definition at line 723 of file ITHACAstream.H.

SaveDenseMatrixList()

template<typename MatrixType>

void ITHACAstream::SaveDenseMatrixList	(	List< MatrixType > &	MatrixList,
		word	folder,
		word	MatrixName )

Save a dense matrix list to bynary files.

Parameters

[in]	MatrixList	The matrix list
[in]	folder	The folder where you want to save files
[in]	MatrixName	The matrix name prefix, files are the named with an incremental number

Template Parameters

MatrixType

MatrixType type of the matrix, i.e. double, float, ...

Definition at line 822 of file ITHACAstream.H.

SaveDenseTensor()

template<typename TensorType>

void ITHACAstream::SaveDenseTensor	(	TensorType &	Tensor,
		word	folder,
		word	MatrixName )

Save a dense tensor to file.

Parameters

[in]	Tensor	The tensor
[in]	folder	Folder where you want to save the tensor
[in]	MatrixName	The matrix name

Template Parameters

TensorType

type of the tensor, i.e. double, float, ...

Definition at line 766 of file ITHACAstream.H.

SaveSparseMatrix()

template<typename T, int Nrows, typename IND>

void ITHACAstream::SaveSparseMatrix	(	Eigen::SparseMatrix< T, Nrows, IND > &	m,
		word	folder,
		word	MatrixName )

Export an Eigen sparse matrix into bynary format file.

Parameters

	m	Eigen::SparseMatrix
[in]	folder	The folder where you want to save the matrix
[in]	MatrixName	The matrix name for the output file

Template Parameters

T	type of the matrix, i.e. double, float, ...
Nrows	number of matrix rows
IND	number of matrix cols

SaveSparseMatrixList()

template<typename MatrixType>

void ITHACAstream::SaveSparseMatrixList	(	List< MatrixType > &	MatrixList,
		word	folder,
		word	MatrixName )

Save a sparse matrix list to bynary files.

Parameters

[in]	MatrixList	The matrix list
[in]	folder	The folder where you want to save files
[in]	MatrixName	The matrix name prefix, files are the named with an incremental number

Template Parameters

MatrixType

MatrixType type of the matrix, i.e. double, float, ...

Definition at line 812 of file ITHACAstream.H.

writePoints()

void ITHACAstream::writePoints	(	pointField	points,
		fileName	folder,
		fileName	subfolder )

Write points of a mesh to a file.

Parameters

[in]	points	The points you want to write
[in]	folder	The folder where you want to save the file
[in]	subfolder	The subfolder where you want to save the file

Definition at line 1092 of file ITHACAstream.C.