OSHUN  beta
Arbitrary Order Spherical-Harmonic 1D-3P Vlasov-Fokker-Planck-Maxwell code
Export_Files::Header Class Reference

#include <export.h>

Public Member Functions

 Header ()
 
 Header (oAxis _x, string _Ql, float _Qc, string _tl, string _tu, float _tc, string _oD)
 
 Header (oAxis _x, oAxis _y, string _Ql, float _Qc, string _tl, string _tu, float _tc, string _oD)
 
 Header (oAxis _x, oAxis _y, oAxis _z, string _Ql, float _Qc, string _tl, string _tu, float _tc, string _oD)
 
 Header (vector< oAxis > _xyz, string _Ql, float _Qc, string _tl, string _tu, float _tc, string _oD)
 
size_t dim ()
 
valarray< float > axis (const size_t i)
 
string label (const size_t i)
 
string units (const size_t i)
 
float conv (const size_t i)
 
float min (const size_t i)
 
float max (const size_t i)
 
string Title_label ()
 
float Title_conv ()
 
string Time_label ()
 
float Time_conv ()
 
string Directory ()
 

Private Attributes

vector< oAxisxyz_axis
 
string title
 
string time
 
string timeU
 
float titleC
 
float timeC
 
string oDir
 

Detailed Description

Definition at line 134 of file export.h.

Constructor & Destructor Documentation

◆ Header() [1/5]

Export_Files::Header::Header ( )
inline

Definition at line 138 of file export.h.

Referenced by Export_Files::Xport::Xport().

138 { };
Here is the caller graph for this function:

◆ Header() [2/5]

Export_Files::Header::Header ( oAxis  _x,
string  _Ql,
float  _Qc,
string  _tl,
string  _tu,
float  _tc,
string  _oD 
)

Definition at line 459 of file export.cpp.

References xyz_axis.

463  : title(_Ql), titleC(_Qc),
464  time(_tl), timeU(_tu), timeC(_tc),
465  oDir(_oD) {
466  xyz_axis.push_back(_x);
467 }
vector< oAxis > xyz_axis
Definition: export.h:164

◆ Header() [3/5]

Export_Files::Header::Header ( oAxis  _x,
oAxis  _y,
string  _Ql,
float  _Qc,
string  _tl,
string  _tu,
float  _tc,
string  _oD 
)

Definition at line 470 of file export.cpp.

References xyz_axis.

474  : title(_Ql), time(_tl), timeU(_tu),
475  titleC(_Qc), timeC(_tc),
476  oDir(_oD) {
477  xyz_axis.push_back(_x);
478  xyz_axis.push_back(_y);
479 }
vector< oAxis > xyz_axis
Definition: export.h:164

◆ Header() [4/5]

Export_Files::Header::Header ( oAxis  _x,
oAxis  _y,
oAxis  _z,
string  _Ql,
float  _Qc,
string  _tl,
string  _tu,
float  _tc,
string  _oD 
)

Definition at line 482 of file export.cpp.

References xyz_axis.

486  : title(_Ql), time(_tl), timeU(_tu),
487  titleC(_Qc), timeC(_tc),
488  oDir(_oD) {
489  xyz_axis.push_back(_x);
490  xyz_axis.push_back(_y);
491  xyz_axis.push_back(_z);
492 }
vector< oAxis > xyz_axis
Definition: export.h:164

◆ Header() [5/5]

Export_Files::Header::Header ( vector< oAxis _xyz,
string  _Ql,
float  _Qc,
string  _tl,
string  _tu,
float  _tc,
string  _oD 
)

Definition at line 495 of file export.cpp.

499  : xyz_axis(_xyz), title(_Ql), time(_tl), timeU(_tu),
500  titleC(_Qc), timeC(_tc),
501  oDir(_oD) {}
vector< oAxis > xyz_axis
Definition: export.h:164

Member Function Documentation

◆ axis()

valarray< float > Export_Files::Header::axis ( const size_t  i)

Definition at line 509 of file export.cpp.

References Algorithms::MakeCAxis(), max(), min(), and xyz_axis.

509  {
510 // return Algorithms::MakeAxis(xyz_axis[i].min, xyz_axis[i].max, xyz_axis[i].sz);
511  return Algorithms::MakeCAxis(xyz_axis[i].min, xyz_axis[i].max, xyz_axis[i].sz);
512 }
float min(const size_t i)
Definition: export.h:154
float max(const size_t i)
Definition: export.h:155
valarray< T > MakeCAxis(const T min, const T max, const size_t N)
vector< oAxis > xyz_axis
Definition: export.h:164
Here is the call graph for this function:

◆ conv()

float Export_Files::Header::conv ( const size_t  i)

◆ dim()

size_t Export_Files::Header::dim ( )

Definition at line 504 of file export.cpp.

References xyz_axis.

Referenced by Export_Files::Xport::Export_h5().

504  {
505  return xyz_axis.size();
506 }
vector< oAxis > xyz_axis
Definition: export.h:164
Here is the caller graph for this function:

◆ Directory()

string Export_Files::Header::Directory ( )

Definition at line 524 of file export.cpp.

References oDir.

Referenced by Export_Files::Xport::Export_h5().

524 { return oDir; }
Here is the caller graph for this function:

◆ label()

string Export_Files::Header::label ( const size_t  i)

Definition at line 513 of file export.cpp.

References xyz_axis.

Referenced by Export_Files::Xport::Xport().

513  {
514  return xyz_axis[i].label;
515 }
vector< oAxis > xyz_axis
Definition: export.h:164
Here is the caller graph for this function:

◆ max()

float Export_Files::Header::max ( const size_t  i)
inline

Definition at line 155 of file export.h.

Referenced by axis(), and Export_Files::Xport::Export_h5().

155 {return(xyz_axis[i].max);}
float max(const size_t i)
Definition: export.h:155
vector< oAxis > xyz_axis
Definition: export.h:164
Here is the caller graph for this function:

◆ min()

float Export_Files::Header::min ( const size_t  i)
inline

Definition at line 154 of file export.h.

Referenced by axis(), and Export_Files::Xport::Export_h5().

154 {return(xyz_axis[i].min);}
float min(const size_t i)
Definition: export.h:154
vector< oAxis > xyz_axis
Definition: export.h:164
Here is the caller graph for this function:

◆ Time_conv()

float Export_Files::Header::Time_conv ( )

Definition at line 523 of file export.cpp.

References timeC.

523 { return timeC; }

◆ Time_label()

string Export_Files::Header::Time_label ( )

Definition at line 522 of file export.cpp.

References time.

522 { return time; }

◆ Title_conv()

float Export_Files::Header::Title_conv ( )

Definition at line 521 of file export.cpp.

References titleC.

521 { return titleC; }

◆ Title_label()

string Export_Files::Header::Title_label ( )

Definition at line 520 of file export.cpp.

References title.

520 { return title; }

◆ units()

string Export_Files::Header::units ( const size_t  i)

Definition at line 516 of file export.cpp.

References xyz_axis.

516  {
517  return xyz_axis[i].units;
518 }
vector< oAxis > xyz_axis
Definition: export.h:164

Field Documentation

◆ oDir

string Export_Files::Header::oDir
private

Definition at line 167 of file export.h.

Referenced by Directory().

◆ time

string Export_Files::Header::time
private

◆ timeC

float Export_Files::Header::timeC
private

Definition at line 166 of file export.h.

Referenced by Time_conv().

◆ timeU

string Export_Files::Header::timeU
private

Definition at line 165 of file export.h.

◆ title

string Export_Files::Header::title
private

Definition at line 165 of file export.h.

Referenced by Title_label().

◆ titleC

float Export_Files::Header::titleC
private

Definition at line 166 of file export.h.

Referenced by Title_conv().

◆ xyz_axis

vector< oAxis > Export_Files::Header::xyz_axis
private

Definition at line 164 of file export.h.

Referenced by axis(), dim(), Header(), label(), and units().


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