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

#include <pseudo_inverse_diag.hpp>

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

Public Member Functions

 PseudoInvDiagnostics ()
 
void init (NLReader::NamelistReader &nlr, int f_source_period, const std::string &name)
 
void write (const Simulation< DeviceType > &sml, const Grid< DeviceType > &grid, const MagneticField< DeviceType > &magnetic_field, const Species< DeviceType > &species, const DomainDecomposition< DeviceType > &pol_decomp, uint64_t plane, int n_species, int n_nodes_all, int n_nodes_pseudo_inv_converged_all, int n_nodes_pseudo_inv_diverged_all, int n_nodes_pseudo_inv_skipped_all, View< int *, CLayout, HostType > pseudo_inv_num_its, View< bool *, CLayout, HostType > pseudo_inv_converged_node)
 
- Public Member Functions inherited from Diagnostic
bool is_triggered (int step)
 
bool has_been_triggered (int step)
 
 Diagnostic ()
 
void init (const std::string &name, int period, int first_step=-1)
 

Additional Inherited Members

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

Constructor & Destructor Documentation

PseudoInvDiagnostics::PseudoInvDiagnostics ( )
inline

Member Function Documentation

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

< switches pseudo-inverse diagnostics on and off, only used if f0_velocity_interp_use_pseudo_inv = .true.

Here is the call graph for this function:

Here is the caller graph for this function:

void PseudoInvDiagnostics::write ( const Simulation< DeviceType > &  sml,
const Grid< DeviceType > &  grid,
const MagneticField< DeviceType > &  magnetic_field,
const Species< DeviceType > &  species,
const DomainDecomposition< DeviceType > &  pol_decomp,
uint64_t  plane,
int  n_species,
int  n_nodes_all,
int  n_nodes_pseudo_inv_converged_all,
int  n_nodes_pseudo_inv_diverged_all,
int  n_nodes_pseudo_inv_skipped_all,
View< int *, CLayout, HostType pseudo_inv_num_its,
View< bool *, CLayout, HostType pseudo_inv_converged_node 
)

Writes pseudo-inverse diagnostics.

Parameters
[in]smlContains simulation control parameters.
[in]gridSpatial grid object.
[in]magnetic_fieldMagnetic field object
[in]speciesContains species parameters.
[in]pol_decompContains poloidal decomposition info.
[in]planePoloidal plane number.
[in]n_speciesTotal number of species.
[in]n_nodes_allTotal number of nodes all planes.
[in]n_nodes_pseudo_inv_converged_allTotal number of nodes all planes where pseudo-inverse converged.
[in]n_nodes_pseudo_inv_diverged_allTotal number of nodes all planes where pseudo-inverse diverged.
[in]n_nodes_pseudo_inv_skipped_allTotal number of nodes all planes where pseudo-inverse was skipped.
[in]pseudo_inv_num_itsNumber of iterations for pseudo-inverse solver in PETSc for each node in the poloidal plane.
[in]pseudo_inv_converged_nodetrue if the pseudo-inverse calculation converged (otherwise false) for each node in the poloidal plane.
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: