XGC1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | Private Attributes | List of all members
CheckpointFiles Class Reference

#include <checkpoint_files.hpp>

Collaboration diagram for CheckpointFiles:
Collaboration graph
[legend]

Public Member Functions

 CheckpointFiles (NLReader::NamelistReader &nlr)
 
bool do_restart (NLReader::NamelistReader &nlr)
 
bool write_restart_now (int gstep)
 
void write (const Simulation< DeviceType > &sml, const Grid< DeviceType > &grid, const MagneticField< DeviceType > &magnetic_field, ElectricField< DeviceType > &electric_field, Plasma &plasma, const Sheath< DeviceType > &sheath, const Charges &charges, const PerturbedBField< DeviceType > &perturbed_B_field, const VelocityGrid &vgrid, const Neutrals< DeviceType > &neutrals, DomainDecomposition< DeviceType > &pol_decomp, DMWrapper &pseudo_inv_dm, Diagnostics &diagnostics, RestartOption restart_option=RestartOption::NotFinal)
 
void read (Simulation< DeviceType > &sml, Plasma &plasma, ElectricField< DeviceType > &electric_field, Sheath< DeviceType > &sheath, Charges &charges, PerturbedBField< DeviceType > &perturbed_B_field, DomainDecomposition< DeviceType > &pol_decomp, const Grid< DeviceType > &grid, const MagneticField< DeviceType > &magnetic_field, const VelocityGrid &vgrid, Neutrals< DeviceType > &neutrals)
 

Public Attributes

int restart_write_period
 How many steps between restart writes. More...
 
int run_count
 How many times the simulation has been restarted. More...
 

Private Attributes

XGC_IO_Stream stream
 
bool adios_stage_restart
 Enable/disable Adios stage mode for xgc.restart. More...
 
bool adios_stage_restart_f0
 Enable/disable Adios stage mode for xgc.restartf0. More...
 
bool increase_ptl_tor_on
 
IncreasePtlTorSettings increase_ptl_tor_settings
 

Constructor & Destructor Documentation

CheckpointFiles::CheckpointFiles ( NLReader::NamelistReader nlr)
inline

< increase # of particle with different toroidal angle when reading restart file

Here is the call graph for this function:

Member Function Documentation

bool CheckpointFiles::do_restart ( NLReader::NamelistReader nlr)

< Whether to restart if possible

Here is the call graph for this function:

void CheckpointFiles::read ( Simulation< DeviceType > &  sml,
Plasma plasma,
ElectricField< DeviceType > &  electric_field,
Sheath< DeviceType > &  sheath,
Charges charges,
PerturbedBField< DeviceType > &  perturbed_B_field,
DomainDecomposition< DeviceType > &  pol_decomp,
const Grid< DeviceType > &  grid,
const MagneticField< DeviceType > &  magnetic_field,
const VelocityGrid vgrid,
Neutrals< DeviceType > &  neutrals 
)

Here is the call graph for this function:

void CheckpointFiles::write ( const Simulation< DeviceType > &  sml,
const Grid< DeviceType > &  grid,
const MagneticField< DeviceType > &  magnetic_field,
ElectricField< DeviceType > &  electric_field,
Plasma plasma,
const Sheath< DeviceType > &  sheath,
const Charges charges,
const PerturbedBField< DeviceType > &  perturbed_B_field,
const VelocityGrid vgrid,
const Neutrals< DeviceType > &  neutrals,
DomainDecomposition< DeviceType > &  pol_decomp,
DMWrapper pseudo_inv_dm,
Diagnostics diagnostics,
RestartOption  restart_option = RestartOption::NotFinal 
)

Writes restart files. If at the end of the simulation and resampling is on, data is moved from the phase space mesh into the particle weights first.

Parameters
[in]smlis used for the resampling control parameters
Returns
void

Here is the call graph for this function:

bool CheckpointFiles::write_restart_now ( int  gstep)

Here is the call graph for this function:

Member Data Documentation

bool CheckpointFiles::adios_stage_restart
private

Enable/disable Adios stage mode for xgc.restart.

bool CheckpointFiles::adios_stage_restart_f0
private

Enable/disable Adios stage mode for xgc.restartf0.

bool CheckpointFiles::increase_ptl_tor_on
private
IncreasePtlTorSettings CheckpointFiles::increase_ptl_tor_settings
private
int CheckpointFiles::restart_write_period

How many steps between restart writes.

int CheckpointFiles::run_count

How many times the simulation has been restarted.

XGC_IO_Stream CheckpointFiles::stream
private

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