RM_interface_C.h

Go to the documentation of this file.

 
#ifdef USE_MPI
#include "mpi.h"
#define MP_TYPE MPI_Comm
#else
#define MP_TYPE int
#endif
 
#include "IrmResult.h"
#ifndef RM_INTERFACE_C_H
#define RM_INTERFACE_C_H
 
#include "irm_dll_export.h"
 
#if defined(__cplusplus)
extern "C" {
#endif
    IRM_DLL_EXPORT int        RM_BmiCreate(int nxyz, MP_TYPE nthreads);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiDestroy(int id);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiAddOutputVars(int id, char* option, char* def);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiFinalize(int id);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetComponentName(int id, char* component_name, int l);
    IRM_DLL_EXPORT double     RM_BmiGetCurrentTime(int id);
    IRM_DLL_EXPORT double     RM_BmiGetEndTime(int id);
    IRM_DLL_EXPORT int        RM_BmiGetGridRank(int id, int grid);
    IRM_DLL_EXPORT int        RM_BmiGetGridSize(int id, int grid);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetGridType(int id, int grid, char* str, int l);
    IRM_DLL_EXPORT int        RM_BmiGetInputItemCount(int id);
    //IRM_DLL_EXPORT int        RM_BmiGetInputVarNamesSize(int id);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetInputVarName(int id, int i, char* name, int l);
    //IRM_DLL_EXPORT int        RM_BmiGetNames(int id, const char* type, char* dest);
    //IRM_DLL_EXPORT int        RM_BmiGetNamesSize(int id, const char* type, int* dest);
    IRM_DLL_EXPORT int        RM_BmiGetOutputItemCount(int id);
    //IRM_DLL_EXPORT int        RM_BmiGetOutputVarNamesSize(int id);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetOutputVarName(int id, int i, char* name, int l);
    IRM_DLL_EXPORT int        RM_BmiGetPointableItemCount(int id);
    //IRM_DLL_EXPORT int        RM_BmiGetPointableVarNamesSize(int id);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetPointableVarName(int id, int i, char* name, int l);
    IRM_DLL_EXPORT double     RM_BmiGetStartTime(int id);
    IRM_DLL_EXPORT double     RM_BmiGetTime(int id);
    IRM_DLL_EXPORT double     RM_BmiGetTimeStep(int id);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetTimeUnits(int id, char* units, int l);
    // GetValue
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetValueInt(int id, char* var, int* dest);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetValueDouble(int id, char* var, double* dest);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetValueChar(int id, char* var, char* dest, int l);
    // GetValuePtr
    //IRM_DLL_EXPORT IRM_RESULT RM_BmiGetValuePtrInt(int id, char* var, int** dest);
    //IRM_DLL_EXPORT IRM_RESULT RM_BmiGetValuePtrDouble(int id, char* var, double** dest);
    //IRM_DLL_EXPORT IRM_RESULT RM_BmiGetValuePtrChar(int id, char* var, char** dest);
    IRM_DLL_EXPORT void* RM_BmiGetValuePtr(int id, char* var);
    IRM_DLL_EXPORT int        RM_BmiGetVarGrid(int id, char* var);
    IRM_DLL_EXPORT int        RM_BmiGetVarItemsize(int id, char* name);
    IRM_DLL_EXPORT int        RM_BmiGetVarNbytes(int id, char* name);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetVarType(int id, char* name, char* vtype, int l);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiGetVarUnits(int id, char* name, char* units, int l);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiInitialize(int id, char* config_file);
    //
    // SetValue methods
    //
    IRM_DLL_EXPORT IRM_RESULT RM_BmiSetValueChar(int id, char* name, const char* src);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiSetValueDouble(int id, char* name, double src);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiSetValueDoubleArray(int id, char* name, double* src);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiSetValueInt(int id, char* name, int src);
#ifdef SKIP
    IRM_DLL_EXPORT IRM_RESULT RM_BmiSetValueIntArray(int id, char* name, int* src);
#endif
    IRM_DLL_EXPORT IRM_RESULT RM_BmiUpdate(int id);
    IRM_DLL_EXPORT IRM_RESULT RM_BmiUpdateUntil(int id, double end_time);
    IRM_DLL_EXPORT void RM_BmiGetValueAtIndices(int id, char* name, void* dest, int* inds, int count);
    IRM_DLL_EXPORT void RM_BmiSetValueAtIndices(int id, char* name, int* inds, int count, void* src);
    IRM_DLL_EXPORT void RM_BmiGetGridShape(int id, const int grid, int* shape);
    IRM_DLL_EXPORT void RM_BmiGetGridSpacing(int id, const int grid, double* spacing);
    IRM_DLL_EXPORT void RM_BmiGetGridOrigin(int id, const int grid, double* origin);
    IRM_DLL_EXPORT void RM_BmiGetGridX(int id, const int grid, double* x);
    IRM_DLL_EXPORT void RM_BmiGetGridY(int id, const int grid, double* y);
    IRM_DLL_EXPORT void RM_BmiGetGridZ(int id, const int grid, double* z);
    IRM_DLL_EXPORT int RM_BmiGetGridNodeCount(int id, const int grid);
    IRM_DLL_EXPORT int RM_BmiGetGridEdgeCount(int id, const int grid);
    IRM_DLL_EXPORT int RM_BmiGetGridFaceCount(int id, const int grid);
    IRM_DLL_EXPORT void RM_BmiGetGridEdgeNodes(int id, const int grid, int* edge_nodes);
    IRM_DLL_EXPORT void RM_BmiGetGridFaceEdges(int id, const int grid, int* face_edges);
    IRM_DLL_EXPORT void RM_BmiGetGridFaceNodes(int id, const int grid, int* face_nodes);
    IRM_DLL_EXPORT void RM_BmiGetGridNodesPerFace(int id, const int grid, int* nodes_per_face);
 
 
 
 
IRM_DLL_EXPORT IRM_RESULT RM_Abort(int id, int result, const char * err_str);
IRM_DLL_EXPORT IRM_RESULT        RM_CloseFiles(int id);
IRM_DLL_EXPORT int        RM_Concentrations2Utility(int id, double *c, int n, double *tc, double *p_atm);
#ifdef USE_MPI
IRM_DLL_EXPORT int RM_Create(int nxyz, MPI_Comm comm);
#else
IRM_DLL_EXPORT int RM_Create(int nxyz, int nthreads);
#endif
IRM_DLL_EXPORT IRM_RESULT RM_CreateMapping (int id, int *grid2chem);
IRM_DLL_EXPORT IRM_RESULT RM_DecodeError (int id, int e);
IRM_DLL_EXPORT IRM_RESULT RM_Destroy(int id);
IRM_DLL_EXPORT IRM_RESULT RM_DumpModule(int id, int dump_on, int append);
IRM_DLL_EXPORT IRM_RESULT RM_ErrorMessage(int id, const char *errstr);
IRM_DLL_EXPORT int        RM_FindComponents(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetBackwardMapping(int id, int n, int *list, int *size);
IRM_DLL_EXPORT int        RM_GetChemistryCellCount(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetComponent(int id, int num, char *chem_name, int l);
IRM_DLL_EXPORT int RM_GetComponentCount(int id);
 
IRM_DLL_EXPORT IRM_RESULT RM_GetConcentrations(int id, double *c);
IRM_DLL_EXPORT IRM_RESULT RM_GetIthConcentration(int id, int i, double* c);
IRM_DLL_EXPORT IRM_RESULT RM_GetIthSpeciesConcentration(int id, int i, double* c);
IRM_DLL_EXPORT IRM_RESULT RM_SetIthConcentration(int id, int i, double* c);
IRM_DLL_EXPORT IRM_RESULT RM_SetIthSpeciesConcentration(int id, int i, double* c);
 
IRM_DLL_EXPORT int RM_GetCurrentSelectedOutputUserNumber(int id);
 
IRM_DLL_EXPORT IRM_RESULT RM_GetDensityCalculated(int id, double *density);
IRM_DLL_EXPORT IRM_RESULT RM_GetDensity(int id, double* density);
 
 
IRM_DLL_EXPORT IRM_RESULT RM_GetEndCell(int id, int *ec);
IRM_DLL_EXPORT int        RM_GetEquilibriumPhasesCount(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetEquilibriumPhasesName(int id, int num, char *name, int l1);
IRM_DLL_EXPORT IRM_RESULT RM_GetErrorString(int id, char *errstr, int l);
IRM_DLL_EXPORT int RM_GetErrorStringLength(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetExchangeName(int id, int num, char *name, int l1);
IRM_DLL_EXPORT int RM_GetExchangeSpeciesCount(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetExchangeSpeciesName(int id, int num, char *name, int l1);
IRM_DLL_EXPORT IRM_RESULT RM_GetFilePrefix(int id, char *prefix, int l);
IRM_DLL_EXPORT int        RM_GetGasComponentsCount(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetGasComponentsName(int id, int num, char *name, int l1);
IRM_DLL_EXPORT IRM_RESULT RM_GetGasCompMoles(int id, double* gas_moles);
IRM_DLL_EXPORT IRM_RESULT RM_GetGasCompPressures(int id, double* gas_pressure);
IRM_DLL_EXPORT IRM_RESULT RM_GetGasCompPhi(int id, double* gas_phi);
IRM_DLL_EXPORT IRM_RESULT RM_GetGasPhaseVolume(int id, double* gas_volume);
IRM_DLL_EXPORT IRM_RESULT RM_GetGfw(int id, double * gfw);
IRM_DLL_EXPORT int        RM_GetGridCellCount(int id);
 
#ifdef USE_YAML
IRM_DLL_EXPORT int        RM_GetGridCellCountYAML(const char* config_file);
#endif
IRM_DLL_EXPORT int        RM_GetIPhreeqcId(int id, int i);
IRM_DLL_EXPORT int        RM_GetKineticReactionsCount(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetKineticReactionsName(int id, int num, char *name, int l1);
IRM_DLL_EXPORT int        RM_GetMpiMyself(int id);
IRM_DLL_EXPORT int        RM_GetMpiTasks(int id);
IRM_DLL_EXPORT int        RM_GetNthSelectedOutputUserNumber(int id, int n);
IRM_DLL_EXPORT IRM_RESULT RM_GetPorosity(int id, double* porosity);
IRM_DLL_EXPORT IRM_RESULT RM_GetPressure(int id, double* pressure);
 
IRM_DLL_EXPORT IRM_RESULT               RM_GetSaturationCalculated(int id, double *sat_calc);
IRM_DLL_EXPORT IRM_RESULT               RM_GetSaturation(int id, double* sat_calc);
 
IRM_DLL_EXPORT IRM_RESULT        RM_GetSelectedOutput(int id, double *so);
 
IRM_DLL_EXPORT int        RM_GetSelectedOutputColumnCount(int id);
IRM_DLL_EXPORT int        RM_GetSelectedOutputCount(int id);
IRM_DLL_EXPORT IRM_RESULT        RM_GetSelectedOutputHeading(int id, int icol, char * heading, int length);
IRM_DLL_EXPORT int        RM_GetSelectedOutputRowCount(int id);
IRM_DLL_EXPORT int        RM_GetSICount(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetSIName(int id, int num, char *name, int l1);
 
IRM_DLL_EXPORT int        RM_GetSolidSolutionComponentsCount(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetSolidSolutionComponentsName(int id, int num, char *name, int l1);
IRM_DLL_EXPORT IRM_RESULT RM_GetSolidSolutionName(int id, int num, char *name, int l1);
 
IRM_DLL_EXPORT IRM_RESULT RM_GetSolutionVolume(int id, double *vol);
IRM_DLL_EXPORT IRM_RESULT RM_GetSpeciesConcentrations(int id, double *species_conc);
IRM_DLL_EXPORT int RM_GetSpeciesCount(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetSpeciesD25(int id, double *diffc);
IRM_DLL_EXPORT IRM_RESULT RM_GetSpeciesLog10Gammas(int id, double *species_log10gammas);
IRM_DLL_EXPORT IRM_RESULT RM_GetSpeciesLog10Molalities(int id, double* species_log10molalities);
IRM_DLL_EXPORT IRM_RESULT RM_GetSpeciesName(int id, int i, char * name, int length);
IRM_DLL_EXPORT int RM_GetSpeciesSaveOn(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetSpeciesZ(int id, double *z);
 
IRM_DLL_EXPORT IRM_RESULT RM_GetStartCell(int id, int *sc);
IRM_DLL_EXPORT IRM_RESULT RM_GetTemperature(int id, double* temperature);
IRM_DLL_EXPORT IRM_RESULT RM_GetSurfaceName(int id, int num, char *name, int l1);
IRM_DLL_EXPORT int        RM_GetSurfaceSpeciesCount(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetSurfaceSpeciesName(int id, int num, char *name, int l1);
IRM_DLL_EXPORT IRM_RESULT RM_GetSurfaceType(int id, int num, char *name, int l1);
IRM_DLL_EXPORT int        RM_GetThreadCount(int id);
IRM_DLL_EXPORT double     RM_GetTime(int id);
IRM_DLL_EXPORT double     RM_GetTimeConversion(int id);
IRM_DLL_EXPORT double     RM_GetTimeStep(int id);
IRM_DLL_EXPORT IRM_RESULT RM_GetViscosity(int id, double* viscosity);
#ifdef USE_YAML
IRM_DLL_EXPORT IRM_RESULT RM_InitializeYAML(int id, const char* yamlfile);
#endif
IRM_DLL_EXPORT IRM_RESULT RM_InitialPhreeqc2Concentrations(
                int id,
                double *c,
                int n_boundary,
                int *boundary_solution1,
                int *boundary_solution2,
                double *fraction1);
IRM_DLL_EXPORT  IRM_RESULT RM_InitialSolutions2Module(int id, int* solutions);
IRM_DLL_EXPORT  IRM_RESULT RM_InitialEquilibriumPhases2Module(int id, int* equilibrium_phases);
IRM_DLL_EXPORT  IRM_RESULT RM_InitialExchanges2Module(int id, int* exchanges);
IRM_DLL_EXPORT  IRM_RESULT RM_InitialSurfaces2Module(int id, int* surfaces);
IRM_DLL_EXPORT  IRM_RESULT RM_InitialGasPhases2Module(int id, int* gas_phases);
IRM_DLL_EXPORT  IRM_RESULT RM_InitialSolidSolutions2Module(int id, int* solid_solutions);
IRM_DLL_EXPORT  IRM_RESULT RM_InitialKinetics2Module(int id, int* kinetics);
IRM_DLL_EXPORT IRM_RESULT RM_InitialPhreeqc2Module(int id,
                int *initial_conditions1,       // 7 x nxyz end-member 1
                int *initial_conditions2,       // 7 x nxyz end-member 2
                double *fraction1);             // 7 x nxyz fraction of end-member 1
 
IRM_DLL_EXPORT IRM_RESULT RM_InitialPhreeqc2SpeciesConcentrations(
                int id,
                double *species_c,
                int n_boundary,
                int *boundary_solution1,
                int *boundary_solution2,
                double *fraction1);
IRM_DLL_EXPORT IRM_RESULT RM_InitialPhreeqcCell2Module(int id,
                int n,                                  // InitialPhreeqc cell number
                int *module_numbers,                    // Module cell numbers
                int dim_module_numbers);                // Number of module cell numbers
 
IRM_DLL_EXPORT IRM_RESULT RM_LoadDatabase(int id, const char *db_name);
IRM_DLL_EXPORT IRM_RESULT RM_LogMessage(int id, const char *str);
IRM_DLL_EXPORT IRM_RESULT RM_MpiWorker(int id);
IRM_DLL_EXPORT IRM_RESULT RM_MpiWorkerBreak(int id);
IRM_DLL_EXPORT IRM_RESULT RM_OpenFiles(int id);
IRM_DLL_EXPORT IRM_RESULT RM_OutputMessage(int id, const char *str);
IRM_DLL_EXPORT IRM_RESULT RM_RunCells(int id);
IRM_DLL_EXPORT IRM_RESULT        RM_RunFile(int id, int workers, int initial_phreeqc, int utility, const char *chem_name);
IRM_DLL_EXPORT IRM_RESULT RM_RunString(int id, int workers, int initial_phreeqc, int utility, const char * input_string);
IRM_DLL_EXPORT IRM_RESULT RM_ScreenMessage(int id, const char *str);
IRM_DLL_EXPORT IRM_RESULT RM_SetComponentH2O(int id, int tf);
IRM_DLL_EXPORT IRM_RESULT RM_SetConcentrations(int id, double *c);
IRM_DLL_EXPORT IRM_RESULT RM_SetCurrentSelectedOutputUserNumber(int id, int n_user);
IRM_DLL_EXPORT IRM_RESULT RM_SetDensityUser(int id, double *density);
IRM_DLL_EXPORT IRM_RESULT RM_SetDensity(int id, double* density);
 
IRM_DLL_EXPORT IRM_RESULT RM_SetDumpFileName(int id, const char *dump_name);
IRM_DLL_EXPORT IRM_RESULT RM_SetErrorHandlerMode(int id, int mode);
IRM_DLL_EXPORT IRM_RESULT RM_SetErrorOn(int id, int tf);
IRM_DLL_EXPORT IRM_RESULT RM_SetFilePrefix(int id, const char *prefix);
 
IRM_DLL_EXPORT IRM_RESULT RM_SetGasCompMoles(int id, double* gas_moles);
 
IRM_DLL_EXPORT IRM_RESULT RM_SetGasPhaseVolume(int id, double* gas_volume);
 
 
IRM_DLL_EXPORT IRM_RESULT RM_SetMpiWorkerCallback(int id, int (*fcn)(int *x1, void *cookie));
IRM_DLL_EXPORT IRM_RESULT RM_SetMpiWorkerCallbackCookie(int id, void *cookie);
IRM_DLL_EXPORT IRM_RESULT RM_SetNthSelectedOutput(int id, int n);
IRM_DLL_EXPORT IRM_RESULT RM_SetPartitionUZSolids(int id, int tf);
IRM_DLL_EXPORT IRM_RESULT RM_SetPorosity(int id, double *por);
IRM_DLL_EXPORT IRM_RESULT RM_SetPressure(int id, double *p);
IRM_DLL_EXPORT IRM_RESULT RM_SetPrintChemistryMask(int id, int *cell_mask);
IRM_DLL_EXPORT IRM_RESULT RM_SetPrintChemistryOn(int id, int workers, int initial_phreeqc, int utility);
 
IRM_DLL_EXPORT IRM_RESULT RM_SetRebalanceByCell(int id, int method);
IRM_DLL_EXPORT IRM_RESULT RM_SetRebalanceFraction(int id, double f);
IRM_DLL_EXPORT IRM_RESULT RM_SetRepresentativeVolume(int id, double *rv);
IRM_DLL_EXPORT IRM_RESULT RM_SetSaturationUser(int id, double *sat);
IRM_DLL_EXPORT IRM_RESULT RM_SetSaturation(int id, double* sat);
IRM_DLL_EXPORT IRM_RESULT RM_SetScreenOn(int id, int tf);
IRM_DLL_EXPORT IRM_RESULT RM_SetSelectedOutputOn(int id, int selected_output);
IRM_DLL_EXPORT IRM_RESULT RM_SetSpeciesSaveOn(int id, int save_on);
IRM_DLL_EXPORT IRM_RESULT RM_SetTemperature(int id, double *t);
IRM_DLL_EXPORT IRM_RESULT RM_SetTime(int id, double time);
IRM_DLL_EXPORT IRM_RESULT RM_SetTimeConversion(int id, double conv_factor);
IRM_DLL_EXPORT IRM_RESULT RM_SetTimeStep(int id, double time_step);
IRM_DLL_EXPORT IRM_RESULT RM_SetUnitsExchange(int id, int option);
IRM_DLL_EXPORT IRM_RESULT RM_SetUnitsGasPhase(int id, int option);
IRM_DLL_EXPORT IRM_RESULT RM_SetUnitsKinetics(int id, int option);
IRM_DLL_EXPORT IRM_RESULT RM_SetUnitsPPassemblage(int id, int option);
IRM_DLL_EXPORT IRM_RESULT RM_SetUnitsSolution(int id, int option);
IRM_DLL_EXPORT IRM_RESULT RM_SetUnitsSSassemblage(int id, int option);
IRM_DLL_EXPORT IRM_RESULT RM_SetUnitsSurface(int id, int option);
IRM_DLL_EXPORT IRM_RESULT RM_SpeciesConcentrations2Module(int id, double * species_conc);
IRM_DLL_EXPORT IRM_RESULT RM_StateSave(int id, int istate);
IRM_DLL_EXPORT IRM_RESULT RM_StateApply(int id, int istate);
IRM_DLL_EXPORT IRM_RESULT RM_StateDelete(int id, int istate);
IRM_DLL_EXPORT IRM_RESULT RM_UseSolutionDensityVolume(int id, int tf);
IRM_DLL_EXPORT IRM_RESULT RM_WarningMessage(int id, const char *warn_str);
 
#if defined(__cplusplus)
}
#endif
 
#endif // RM_INTERFACE_C_H