criptic v1
Cosmic Ray Interstellar Propagation Tool using Itô Calculus
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
criptic::GizmoReader Class Reference

A class to hold all relevant data from a GIZMO snapshot file. More...

#include <GizmoGas.H>

Public Member Functions

 GizmoReader (std::string filename)
 Construct a GizmoReader object from a GIZMO file.
 

Static Public Member Functions

template<typename T >
static void giveUnits (std::vector< T > &unscaled, Real unit)
 Multiply all elements of a vector by a unit to scale.
 

Public Attributes

std::string file
 
std::vector< double > smooth
 
std::vector< double > density
 
std::vector< double > ionDensity
 
std::vector< double > hIfrac
 
std::vector< double > hIIfrac
 
std::vector< double > heIfrac
 
std::vector< double > heIIfrac
 
std::vector< double > heIIIfrac
 
std::vector< double > elAbundance
 
std::vector< double > metals
 
std::vector< RealVecvelocity
 
std::vector< RealVecposition
 
std::vector< RealVecmagField
 

Detailed Description

A class to hold all relevant data from a GIZMO snapshot file.

This class stores the total data from a GIZMO snapshot files as vectors of Reals and RealVecs. This is a member of the GizmoGas class, which is a Gas class used to initiate gas for simulations.

Constructor & Destructor Documentation

◆ GizmoReader()

GizmoReader::GizmoReader ( std::string  filename)

Construct a GizmoReader object from a GIZMO file.

Parameters
filenamestring to represent file name and path from root

Member Function Documentation

◆ giveUnits()

template<typename T >
static void criptic::GizmoReader::giveUnits ( std::vector< T > &  unscaled,
Real  unit 
)
inlinestatic

Multiply all elements of a vector by a unit to scale.

Template Parameters
TThe type of data to be scaled: must have multiplication defined
Parameters
unscaledvector<T> of data to scale
unitReal number to scale units by

This function is a shortcut to supply units to data when reading in a GIZMO file. The implementation does not check the data itself to find units so units must be set manually for the gas simulation used

Member Data Documentation

◆ density

std::vector<double> criptic::GizmoReader::density

Mass Density

◆ elAbundance

std::vector<double> criptic::GizmoReader::elAbundance

Electron abundance per hydrogen

◆ file

std::string criptic::GizmoReader::file

Snapshot file name

◆ heIfrac

std::vector<double> criptic::GizmoReader::heIfrac

Fraction of HeI

◆ heIIfrac

std::vector<double> criptic::GizmoReader::heIIfrac

Fraction of HeII

◆ heIIIfrac

std::vector<double> criptic::GizmoReader::heIIIfrac

Fraction of HeIII

◆ hIfrac

std::vector<double> criptic::GizmoReader::hIfrac

Fraction of HI

◆ hIIfrac

std::vector<double> criptic::GizmoReader::hIIfrac

Fraction of HII

◆ ionDensity

std::vector<double> criptic::GizmoReader::ionDensity

Ionised mass density

◆ magField

std::vector<RealVec> criptic::GizmoReader::magField

3D Particle magnetic fields

◆ metals

std::vector<double> criptic::GizmoReader::metals

Metals per unit mass

◆ position

std::vector<RealVec> criptic::GizmoReader::position

3D Particle position co-ordinates

◆ smooth

std::vector<double> criptic::GizmoReader::smooth

Smoothing lengths

◆ velocity

std::vector<RealVec> criptic::GizmoReader::velocity

3D Particle velocities


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