PanPhaseField SDK
pandat_result_utility::Pandat_Result_Table Class Reference

Pandat result table controller. For PanGUI only. More...

#include <pfm_writers.h>

Static Public Member Functions

static void initialize_pandat_result_table (map< int, shared_ptr< P_Result > > &m_result, int ppf_calc_id, vector< pair< string, string > > dbs)
 
static void update_pandat_result_table (map< int, shared_ptr< P_Result > > &m_result, int ppf_calc_id, string pandat_rlt_path, double time_in_sec, double T_in_K, PFM_Stat &stat, bool is_finalized=true)
 
static void update_pandat_result_table_custom (map< int, shared_ptr< P_Result > > &m_result, int ppf_calc_id, string pandat_rlt_path, double time_in_sec, double T_in_K, PFM_Stat &stat, map< string, double > &custom_property, bool is_finalized=true)
 
static void update_stat_spinodal (pandat_result_utility::PFM_Stat &stat, double avg_dt, int tot_steps, map< string, double >energy_terms, VectorMesh< double > *comp_field, vector< string > comp_names, vector< string > phase_names)
 
static void update_stat (PFM_Stat &stat, double avg_dt, int tot_steps, map< string, double >energy_terms, VectorMesh< double > *comp_field, vector< string > comp_names, vector< string > phase_names, VectorMesh< double > *etar)
 

Detailed Description

Pandat result table controller. For PanGUI only.

Member Function Documentation

◆ initialize_pandat_result_table()

static void pandat_result_utility::Pandat_Result_Table::initialize_pandat_result_table ( map< int, shared_ptr< P_Result > > &  m_result,
int  ppf_calc_id,
vector< pair< string, string > >  dbs 
)
inlinestatic

Initialize a pandat result table with given calculation id

Parameters
[out]m_resultthe hashmap of Pandat result tables with key of calculation id
[in]ppf_calc_idthe key to be added
[in]dbsthe database information to be added to result table
Returns
void

◆ update_pandat_result_table()

static void pandat_result_utility::Pandat_Result_Table::update_pandat_result_table ( map< int, shared_ptr< P_Result > > &  m_result,
int  ppf_calc_id,
string  pandat_rlt_path,
double  time_in_sec,
double  T_in_K,
PFM_Stat stat,
bool  is_finalized = true 
)
inlinestatic

Update a pandat result table with given calculation id

Parameters
[out]m_resultthe hashmap of Pandat result tables with key of calculation id
[in]ppf_calc_idthe key to be added
[in]pandat_rlt_paththe path of saving pandat result table
[in]time_in_secthe current moment of heat treatment in seconds
[in]T_in_Kthe current temperature in K
[in]statthe statistics of phase field model at the current moment
[in]is_finalizedcontrol to write xml or not
Returns
void

◆ update_pandat_result_table_custom()

static void pandat_result_utility::Pandat_Result_Table::update_pandat_result_table_custom ( map< int, shared_ptr< P_Result > > &  m_result,
int  ppf_calc_id,
string  pandat_rlt_path,
double  time_in_sec,
double  T_in_K,
PFM_Stat stat,
map< string, double > &  custom_property,
bool  is_finalized = true 
)
inlinestatic

Update a pandat result table for a given calculation id along with a custom_property

Parameters
[out]m_resultthe hashmap of Pandat result tables with key of calculation id
[in]ppf_calc_idthe key to be added.
[in]pandat_rlt_paththe path of saving pandat result table.
[in]time_in_secthe current moment of heat treatment in seconds.
[in]T_in_Kthe current temperature in K.
[in]statthe statistics of phase field model at the current moment.
[in]custom_property(key,value) map of the custom properties.
[in]is_finalizedcontrol to write xml or not.
Returns
void

◆ update_stat_spinodal()

static void pandat_result_utility::Pandat_Result_Table::update_stat_spinodal ( pandat_result_utility::PFM_Stat stat,
double  avg_dt,
int  tot_steps,
map< string, double >  energy_terms,
VectorMesh< double > *  comp_field,
vector< string >  comp_names,
vector< string >  phase_names 
)
inlinestatic

Update statistics of spinodal decomposition

Parameters
[out]statthe statistics of phase field model
[in]avg_dtthe average time step
[in]tot_stepsthe tot steps of time integral
[in]energy_termsthe hashmap of energy terms with key of energy name
[in]comp_fieldthe composition mesh
[in]comp_namesthe name of dimensions in the composition mesh
[in]phase_namesthe phase name of dimensions of the order parameter mesh
Returns
void

◆ update_stat()

static void pandat_result_utility::Pandat_Result_Table::update_stat ( PFM_Stat stat,
double  avg_dt,
int  tot_steps,
map< string, double >  energy_terms,
VectorMesh< double > *  comp_field,
vector< string >  comp_names,
vector< string >  phase_names,
VectorMesh< double > *  etar 
)
inlinestatic

Update statistics of phase field model

Parameters
[out]statthe statistics of phase field model
[in]avg_dtthe average time step
[in]tot_stepsthe tot steps of time integral
[in]energy_termsthe hashmap of energy terms with key of energy name
[in]comp_fieldthe composition mesh
[in]comp_namesthe name of dimensions in the composition mesh
[in]phase_namesthe phase name of dimensions of the order parameter mesh
[in]etarthe order parameter mesh
Returns
void

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