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

#include <loop_voltage_diag.hpp>

Inheritance diagram for LoopVolDiagnostics:
Inheritance graph
[legend]
Collaboration diagram for LoopVolDiagnostics:
Collaboration graph
[legend]

Public Member Functions

 LoopVolDiagnostics ()
 
void init (NLReader::NamelistReader &nlr, int f_source_period, const std::string &name)
 
void write (const Simulation< DeviceType > &sml, const Grid< DeviceType > &grid, const ElectricField< DeviceType > &electric_field, View< double *, CLayout, HostType > &jpara_diff_current)
 
- Public Member Functions inherited from Diagnostic
bool is_triggered (int step)
 
bool has_been_triggered (int step)
 
int get_period () const
 
 Diagnostic ()
 
void init (const std::string &name, int period, int first_step=-1)
 
void open_stream (const std::string &filename, const XGC_IO_Mode &mode)
 
void close_stream ()
 
void write (const XGC_IO &xgc_io)
 
void start_write_step ()
 
bool is_first_step ()
 
void end_write_step ()
 

Additional Inherited Members

- Public Attributes inherited from Diagnostic
bool is_on
 
- Protected Attributes inherited from Diagnostic
StepTrigger step_trigger
 

Detailed Description

DESCRIPTION

Header file to loop_voltage_diag.cpp Contains ADIOS2 diagnostics for the loop voltage current drive.

Constructor & Destructor Documentation

LoopVolDiagnostics::LoopVolDiagnostics ( )
inline

Member Function Documentation

void LoopVolDiagnostics::init ( NLReader::NamelistReader nlr,
int  f_source_period,
const std::string &  name 
)
inline

< Switches the loop voltage diagnostic on if dynamic current drive is on

< Output frequency of loop_voltage_diagnostic

Here is the call graph for this function:

Here is the caller graph for this function:

void LoopVolDiagnostics::write ( const Simulation< DeviceType > &  sml,
const Grid< DeviceType > &  grid,
const ElectricField< DeviceType > &  electric_field,
View< double *, CLayout, HostType > &  jpara_diff_current 
)

DESCRIPTION

Contains ADIOS2 diagnostics for the loop voltage current drive. Writes pseudo-inverse diagnostics.

Parameters
[in]smlContains simulation control parameters.
[in]gridSpatial grid object.
[in]electric_fieldElectric field object
[in]loop_voltage_correctionCorrection of the loop voltage based on j_plasma-j_equil
Returns
void

Here is the call graph for this function:

Here is the caller graph for this function:


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