File List

Here is a list of all documented files with brief descriptions:

[detail level 12]

▼ Containers
MatrixContainer.cpp	The implementation file containing the matrix container
MatrixContainer.h	The header file containing the matrix container
MatrixRecord.cpp	The implementation file containing metadata about matrices stored in the matrix container
MatrixRecord.h	The header file containing metadata about matrices stored in the matrix container
OutputStreamContainer.cpp	The implementation file for the output stream container
OutputStreamContainer.h	The header file defining the output stream container
▼ Hdf5
Hdf5File.cpp	The implementation file containing the HDF5 related classes
Hdf5File.h	The header file containing the HDF5 related classes
Hdf5FileHeader.cpp	The implementation of the class responsible for working with file headers
Hdf5FileHeader.h	The header file containing the class processing file headers. Detail about the file header are described below
▼ KSpaceSolver
KSpaceFirstOrder3DSolver.cpp	The implementation file containing the main class of the project responsible for the entire simulation
KSpaceFirstOrder3DSolver.h	The header file containing the main class of the project responsible for the entire simulation
▼ Logger
ErrorMessages.h	The header file containing routines for error messages and error messages common for both linux and windows version. The specific error messages are in separate files ErrorMessagesLinux.h and ErrorMessagesWindows.h
ErrorMessagesLinux.h	The header file containing linux specific error messages
ErrorMessagesWindows.h	The header file containing windows specific error messages
Logger.cpp	The implementation file containing a class responsible for printing out info and error messages (stdout, and stderr)
Logger.h	The header file containing a class responsible for printing out info and error messages (stdout, and stderr)
OutputMessages.h	The header file including output messages based on the operating system
OutputMessagesLinux.h	The header file containing all linux specific messages going to the standard output
OutputMessagesWindows.h	The header file containing all windows specific messages going to the standard output
▼ MatrixClasses
BaseFloatMatrix.cpp	The implementation file containing the base class for single precisions floating point numbers (floats)
BaseFloatMatrix.h	The header file containing the base class for single precisions floating point numbers (floats)
BaseIndexMatrix.cpp	The implementation file containing the base class for index matrices (based on the size_t datatype)
BaseIndexMatrix.h	The header file containing the base class for index matrices (based on the size_t datatype)
BaseMatrix.h	The header file of the common ancestor of all matrix classes. A pure abstract class
ComplexMatrix.cpp	The implementation file with the class for complex matrices
ComplexMatrix.h	The header file with the class for complex matrices
FftwComplexMatrix.cpp	The implementation file containing the class that implements 3D FFT using the FFTW interface
FftwComplexMatrix.h	The header file containing the class that implements 3D FFT using the FFTW interface
IndexMatrix.cpp	The implementation file containing the class for 64b integer matrices
IndexMatrix.h	The header file containing the class for 64b integer matrices
RealMatrix.cpp	The implementation file containing the class for real matrices
RealMatrix.h	The header file containing the class for real matrices
▼ OutputStreams
BaseOutputStream.cpp	The implementation file of the class saving RealMatrix data into the output HDF5 file
BaseOutputStream.h	The header file of the class saving RealMatrix data into the output HDF5 file
CuboidOutputStream.cpp	The implementation file of classes responsible for storing output quantities based on the cuboid sensor mask into the output HDF5 file
CuboidOutputStream.h	The header file of classes responsible for storing output quantities based on the cuboid sensor mask into the output HDF5 file
IndexOutputStream.cpp	The implementation file of the class saving data based on index senor mask into the output HDF5 file
IndexOutputStream.h	The header file of the class saving data based on the index senor mask into the output HDF5 file
WholeDomainOutputStream.cpp	The implementation file of the class saving RealMatrix data into the output HDF5 file, e.g. p_max_all
WholeDomainOutputStream.h	The header file of the class saving whole RealMatrix into the output HDF5 file, e.g. p_max_all
▼ Parameters
CommandLineParameters.cpp	The implementation file containing the command line parameters
CommandLineParameters.h	The header file containing the command line parameters
Parameters.cpp	The implementation file containing parameters of the simulation
Parameters.h	The header file containing the parameters of the simulation
▼ Utils
DimensionSizes.h	The header file containing the structure with 3D dimension sizes
MatrixNames.h	The header file storing names of all variables
TimeMeasure.h	The header file containing the class measuring elapsed time
main.cpp	The main file of kspaceFirstOrder3D-OMP