user_pfm_pure_solidification.h

Go to the documentation of this file.

 
//                                 //
//    P A N P H A S E F I E L D    //
//                                 //
//         Version 2020            //
//        CompuTherm, LLC          //
//      Copyright, 2000-2020       //
//                                 //
//       www.computherm.com        //
//                                 //
 
#pragma once
 
#include "pfm_solidification_config.h"
#include "ppf_APP_interface.h"
 
// The following ifdef block is the standard way of creating macros which make exporting
// from a DLL simpler. All files within this DLL are compiled with the USER_PFM_PURE_SOLIDIFICATION_EXPORTS
// symbol defined on the command line. This symbol should not be defined on any project
// that uses this DLL. This way any other project whose source files include this file see
// USER_PFM_PURE_SOLIDIFICATION_API functions as being imported from a DLL, whereas this DLL sees symbols
// defined with this macro as being exported.
#ifdef __GNUC__
#define USER_PFM_PURE_SOLIDIFICATION_API
#else
#define USER_PFM_PURE_SOLIDIFICATION_API __declspec(dllexport)
#endif // __GNUC__
 
using namespace std;
 
#ifndef EXTEND_PFM_SDK_OUTPUT
#define EXTEND_PFM_SDK_OUTPUT
#endif // EXTEND_PFM_SDK_OUTPUT
 
class user_pfm_solidification : public I_PFM_APP_Interface
{
 
public:
    user_pfm_solidification();
 
    ~user_pfm_solidification();
 
public:
    void load_arguments(PF_ARGS* m_args, char* msg_char);
 
    void run_pfm_calculation(char *msg);
 
public:
    bool sdk_update_prop(string &msg, int ip);
 
    bool model_update_PFDB_parameters();
 
    void sdk_get_chemical_mobility(double(*chemical_mobility)[PDN_BSZ][PDN_BSZ], double(*atomic_mobility), double(*composition));
 
public:
    void model_allocate_memory();
 
    bool model_initial_condition(string input_path, string irun="circle");
 
    void update_phase_equilibrium();
    
 
 
    double model_get_driving_force();
 
    void model_update_laplace_operation(VectorMesh<double>& field, VectorMesh<double>& lap_field, int index);
 
    void model_update_rate(int index);
 
    bool model_update_field(double dt);
 
private:
    // ------------------------ //
    // PanPhaseField SDK object //
    // ------------------------ //
    PFM_SDK* m_pfm_sdk; 
    PFM_SDK_Variables svar; // For storing the SDK variables.
    double Random_parameter; // Random parameter to demonstrate dynamic parameters.
 
    // -------------------------------------------//
    // Model parameters loaded from PanPhaseField //
    // ------------------------------------------ //
    string calc_name; 
    int num_thread; 
    map<string, double> homogen_condition; 
    int L; 
    int M; 
    int N; 
    vector<int> dim_order_map; 
    TempCalculator m_thermal_stack; 
    double duration; 
    vector<double> plot_time_stack; 
    size_t N_profiles; 
    string imode; 
    string input_vtk_path; 
    double Cijkla, Cijklb, Cijklc; 
    double Gnormal; 
    double Bnormal; 
    double Namp; 
    double lo; 
    double kappa_l; 
    double molar_vol; 
    double tao; 
    double Meta; 
    double sigma_dimensional; 
    double Width_dimensional; 
    double kappa_eta; 
    double omega_eta; 
    vector<string> comp_names; 
    string ref_comp; 
    size_t ncomp; 
    vector<string> phase_names; 
    size_t nphase; 
    // ------------------- //
    // Model selection tag //
    // ------------------- //
    bool cutoff_eta;
 
    // --------------------------------------------------- //
    // VTK I/O related varialbes loaded from PanPhaseField //
    // --------------------------------------------------- //
    string VTK_dir; 
    vtk_stream_utility::VTK_Stream vtk_stream; 
    // ------------------------------------------------ //
    // PanPhaseField SDK related input/output variables //
    // ------------------------------------------------ //
    vector<PFM_SDK_Input_Condition> sdk_input; 
    vector<PFM_SDK_Output_Data> sdk_output; 
    // --------------------- //
    // phase-field mesh grid //
    // --------------------- //
    VectorMesh<double> conc;  
    VectorMesh<double> detadt; 
    VectorMesh<double> lap_eta; 
    VectorMesh<double> dfdeta; 
    VectorMesh<double> etar;  
    int matrix_index; 
    double dG_max; 
    vector<double> Gibbs_energy_shift; // J/mol; Shifting the Gibbs energy of each precipitate
 
    // --------------------- //
    // time-integral related //
    // --------------------- //
    double TK_cur; 
    double dt; 
    double tt; 
    bool was_dt_limited; 
    double dt_before_limited; 
    int iter_step_cnt; 
#ifdef ENABLE_PANDAT_PROGRESS_MESSAGE
    // --------------------------------------------- //
    // (Optional) Pandat GUI progress window message //
    // --------------------------------------------- //
    CALCULATION_PROGRESS m_progress_ptr; 
#endif
 
#ifdef ENABLE_PANDAT_RESULT_TABLE
    // ------------------------------------------------------------------------------ //
    // (Optional) Pandat Result Table I/O related varialbes loaded from PanPhaseField //
    // ------------------------------------------------------------------------------ //
    vector<pair<string, string>> dbs; 
    int ppf_calc_id; 
    string pandat_table_dir; 
    map<string, double> custom_property;
 
    // ------------------------------ //
    // (Optional) Pandat Result Table //
    // ------------------------------ //
    P_Result_Dict m_result; 
#endif
 
#ifdef ENABLE_PERFORMANCE_LOG
    // -------------------------- //
    // (Optional) Performance log //
    // -------------------------- //
    vector<double> sdk_api_call_cnt; 
    double thermodynamic_time; 
#endif
 
 
 
};//end of user_pfm_solidification
 
 
class SOLIDIFICATION_app_Creator : public I_PFM_APP_Creator
{
public:
 
    I_PFM_APP_Interface * Create()
    {
        return new user_pfm_solidification();
    }
 
    void Delete(I_PFM_APP_Interface* user_app) {
        if (user_app != NULL)
        {
            delete user_app;
        }
    }
 
    float getVersion()
    {
        return 1.0;
    }
 
    const char* getName()
    {
        return "USER_PFM_PURE_SOLIDIFICATION";
    }
 
 
    const char* getDescription()
    {
        return "A template plugin for solidification simulation";
    }
};