kspaceFirstOrder3D-OMP 1.0
The C++ implementation of the k-wave toolbox for the time-domain simulation of acoustic wave fields in 3D
Public Types | Public Member Functions | Public Attributes
TMatrixRecord Struct Reference

A structure storing details about the matrix. The matrix container stores this structures.

#include <MatrixContainer.h>

Collaboration diagram for TMatrixRecord:
Collaboration graph
[legend]

List of all members.

Public Types

enum  TMatrixDataType {
  mdtReal, mdtComplex, mdtIndex, mdtFFTW,
  mdtUxyz
}
 All possible types of the matrix.

Public Member Functions

 TMatrixRecord ()
 Default constructor.
 TMatrixRecord (const TMatrixRecord &src)
 Copy constructor.
TMatrixRecordoperator= (const TMatrixRecord &src)
 operator =
void SetAllValues (TBaseMatrix *MatrixPtr, const TMatrixDataType MatrixDataType, const TDimensionSizes DimensionSizes, const bool LoadData, const string HDF5MatrixName)
 Set all values of the record.

Public Attributes

TBaseMatrixMatrixPtr
 Pointer to the matrix object.
TMatrixDataType MatrixDataType
 Matrix data type.
TDimensionSizes DimensionSizes
 Matrix dimension sizes.
bool LoadData
 Is the matrix content loaded from the HDF5 file.
string HDF5MatrixName
 HDF5 matrix name.

Detailed Description

Definition at line 103 of file MatrixContainer.h.


Constructor & Destructor Documentation

TMatrixRecord::TMatrixRecord ( const TMatrixRecord src)

Copy constructor of TMatrixRecord

Parameters:
[in]src

Definition at line 58 of file MatrixContainer.cpp.


Member Function Documentation

TMatrixRecord & TMatrixRecord::operator= ( const TMatrixRecord src)

operator = of TMatrixRecord

Parameters:
[in]src
Returns:
this

Definition at line 74 of file MatrixContainer.cpp.

void TMatrixRecord::SetAllValues ( TBaseMatrix MatrixPtr,
const TMatrixDataType  MatrixDataType,
const TDimensionSizes  DimensionSizes,
const bool  LoadData,
const string  HDF5MatrixName 
)

Set all values for the record

Parameters:
[in]MatrixPtr- Pointer to the MatrixClass object
[in]MatrixDataType- Matrix data type
[in]DimensionSizes- Dimension sizes
[in]LoadData- Load data from file?
[in]HDF5MatrixName- HDF5 matrix name

Definition at line 99 of file MatrixContainer.cpp.


The documentation for this struct was generated from the following files:
 All Classes Files Functions Variables Typedefs Enumerations