PhreeqcRM
YAML_interface_C.h
Go to the documentation of this file.
1
4#ifdef USE_YAML
5#ifndef INC_YAML_interface_C_H
6#define INC_YAML_interface_C_H
7
8#include "irm_dll_export.h"
9
10#if defined(__cplusplus)
11extern "C" {
12#endif
30 IRM_DLL_EXPORT int CreateYAMLPhreeqcRM(void);
31
47 IRM_DLL_EXPORT int DestroyYAMLPhreeqcRM(int id);
48
67 IRM_DLL_EXPORT IRM_RESULT YAMLClear(int id);
68
89 IRM_DLL_EXPORT IRM_RESULT WriteYAMLDoc(int id, const char* file_name);
90
184 IRM_DLL_EXPORT IRM_RESULT YAMLAddOutputVars(int id, char* option, char*
185 def);
186
207 IRM_DLL_EXPORT IRM_RESULT YAMLCloseFiles(int id);
208
243 IRM_DLL_EXPORT IRM_RESULT YAMLCreateMapping(int id, int* grid2chem, int dim);
244
274 IRM_DLL_EXPORT IRM_RESULT YAMLDumpModule(int id, int dump_on, int append);
275
324 IRM_DLL_EXPORT IRM_RESULT YAMLFindComponents(int id);
325
344 IRM_DLL_EXPORT IRM_RESULT YAMLInitialSolutions2Module(int id, int*
345 solutions, int dim);
346
370 equilibrium_phases, int dim);
371
392 IRM_DLL_EXPORT IRM_RESULT YAMLInitialExchanges2Module(int id, int*
393 exchanges, int dim);
394
413 IRM_DLL_EXPORT IRM_RESULT YAMLInitialSurfaces2Module(int id, int* surfaces,
414 int dim);
415
434 IRM_DLL_EXPORT IRM_RESULT YAMLInitialGasPhases2Module(int id, int*
435 gas_phases, int dim);
436
459 solid_solutions, int dim);
478 IRM_DLL_EXPORT IRM_RESULT YAMLInitialKinetics2Module(int id, int* kinetics,
479 int dim);
480
531 IRM_DLL_EXPORT IRM_RESULT YAMLInitialPhreeqc2Module(int id, int* ic1, int
532 dim);
533
607 IRM_DLL_EXPORT IRM_RESULT YAMLInitialPhreeqc2Module_mix(int id, int* ic1,
608 int* ic2, double* f1, int dim);
609
649 int n, int* cell_numbers, int dim);
650
675 IRM_DLL_EXPORT IRM_RESULT YAMLLoadDatabase(int id, const char* database);
676
703 IRM_DLL_EXPORT IRM_RESULT YAMLLogMessage(int id, const char* str);
704
734 IRM_DLL_EXPORT IRM_RESULT YAMLOpenFiles(int id);
735
762 IRM_DLL_EXPORT IRM_RESULT YAMLOutputMessage(int id, const char* str);
763
797 IRM_DLL_EXPORT IRM_RESULT YAMLRunCells(int id);
798
837 IRM_DLL_EXPORT IRM_RESULT YAMLRunFile(int id, int workers, int
838 initial_phreeqc,
839 int utility, const char* file_name);
840
879 IRM_DLL_EXPORT IRM_RESULT YAMLRunString(int id, int workers, int
880 initial_phreeqc,
881 int utility, const char* input_string);
882
910 IRM_DLL_EXPORT IRM_RESULT YAMLScreenMessage(int id, const char* str);
911
946 IRM_DLL_EXPORT IRM_RESULT YAMLSetComponentH2O(int id, int tf);
947
983 IRM_DLL_EXPORT IRM_RESULT YAMLSetConcentrations(int id, double* c, int dim);
984
1017 int n_user);
1018
1054 IRM_DLL_EXPORT IRM_RESULT YAMLSetDensityUser(int id, double* density, int
1055 dim);
1056
1082 IRM_DLL_EXPORT IRM_RESULT YAMLSetDumpFileName(int id, const char*
1083 file_name);
1084
1110 IRM_DLL_EXPORT IRM_RESULT YAMLSetErrorHandlerMode(int id, int mode);
1111
1141 IRM_DLL_EXPORT IRM_RESULT YAMLSetErrorOn(int id, int tf);
1142
1170 IRM_DLL_EXPORT IRM_RESULT YAMLSetFilePrefix(int id, const char* prefix);
1171
1203 IRM_DLL_EXPORT IRM_RESULT YAMLSetGasCompMoles(int id, double* gas_moles,
1204 int dim);
1205
1240 IRM_DLL_EXPORT IRM_RESULT YAMLSetGasPhaseVolume(int id, double* gas_volume,
1241 int dim);
1242
1271 IRM_DLL_EXPORT IRM_RESULT YAMLSetGridCellCount(int id, int count);
1272
1304 IRM_DLL_EXPORT IRM_RESULT YAMLSetNthSelectedOutput(int id, int n);
1305
1343 IRM_DLL_EXPORT IRM_RESULT YAMLSetPartitionUZSolids(int id, int tf);
1344
1377 IRM_DLL_EXPORT IRM_RESULT YAMLSetPorosity(int id, double* por, int dim);
1378
1409 IRM_DLL_EXPORT IRM_RESULT YAMLSetPressure(int id, double* p, int dim);
1410
1443 IRM_DLL_EXPORT IRM_RESULT YAMLSetPrintChemistryMask(int id, int* mask,
1444 int dim);
1445
1492 IRM_DLL_EXPORT IRM_RESULT YAMLSetPrintChemistryOn(int id, int workers, int
1493 initial_phreeqc,
1494 int utility);
1527 IRM_DLL_EXPORT IRM_RESULT YAMLSetRebalanceByCell(int id, int tf);
1528
1564 IRM_DLL_EXPORT IRM_RESULT YAMLSetRebalanceFraction(int id, double f);
1565
1611 IRM_DLL_EXPORT IRM_RESULT YAMLSetRepresentativeVolume(int id, double* rv,
1612 int dim);
1613
1652 IRM_DLL_EXPORT IRM_RESULT YAMLSetSaturationUser(int id, double* sat, int
1653 dim);
1654
1684 IRM_DLL_EXPORT IRM_RESULT YAMLSetScreenOn(int id, int tf);
1685
1717 IRM_DLL_EXPORT IRM_RESULT YAMLSetSelectedOutputOn(int id, int tf);
1718
1751 IRM_DLL_EXPORT IRM_RESULT YAMLSetSpeciesSaveOn(int id, int save_on);
1752
1786 IRM_DLL_EXPORT IRM_RESULT YAMLSetTemperature(int id, double* tc, int dim);
1787
1813 IRM_DLL_EXPORT IRM_RESULT YAMLSetTime(int id, double time);
1814
1843 IRM_DLL_EXPORT IRM_RESULT YAMLSetTimeConversion(int id, double conv_factor);
1844
1872 IRM_DLL_EXPORT IRM_RESULT YAMLSetTimeStep(int id, double time_step);
1873
1920 IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsExchange(int id, int option);
1921
1971 IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsGasPhase(int id, int option);
1972
2041 IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsKinetics(int id, int option);
2042
2090 IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsPPassemblage(int id, int option);
2091
2150 IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsSolution(int id, int option);
2151
2199 IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsSSassemblage(int id, int option);
2200
2247 IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsSurface(int id, int option);
2248
2289 IRM_DLL_EXPORT IRM_RESULT YAMLSpeciesConcentrations2Module(int id, double*
2290 species_conc, int dim);
2291
2327 IRM_DLL_EXPORT IRM_RESULT YAMLStateSave(int id, int istate);
2328
2362 IRM_DLL_EXPORT IRM_RESULT YAMLStateApply(int id, int istate);
2363
2389 IRM_DLL_EXPORT IRM_RESULT YAMLStateDelete(int id, int istate);
2390
2413 IRM_DLL_EXPORT IRM_RESULT YAMLThreadCount(int id, int nthreads);
2414
2461 IRM_DLL_EXPORT IRM_RESULT YAMLUseSolutionDensityVolume(int id, int tf);
2462
2491 IRM_DLL_EXPORT IRM_RESULT YAMLWarningMessage(int id, const char* str);
2492
2493#if defined(__cplusplus)
2494}
2495#endif
2496
2497#endif // INC_YAML_interface_C_H
2498#endif // USE_YAML
IRM_RESULT
Enumeration for PhreeqcRM function return codes.
Definition IrmResult.h:8
IRM_DLL_EXPORT IRM_RESULT YAMLSetComponentH2O(int id, int tf)
IRM_DLL_EXPORT IRM_RESULT YAMLSetConcentrations(int id, double *c, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetRebalanceByCell(int id, int tf)
IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsSurface(int id, int option)
IRM_DLL_EXPORT IRM_RESULT YAMLOpenFiles(int id)
IRM_DLL_EXPORT IRM_RESULT YAMLInitialPhreeqc2Module(int id, int *ic1, int dim)
IRM_DLL_EXPORT int CreateYAMLPhreeqcRM(void)
IRM_DLL_EXPORT IRM_RESULT YAMLStateSave(int id, int istate)
IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsKinetics(int id, int option)
IRM_DLL_EXPORT IRM_RESULT YAMLStateApply(int id, int istate)
IRM_DLL_EXPORT IRM_RESULT YAMLOutputMessage(int id, const char *str)
IRM_DLL_EXPORT IRM_RESULT YAMLSetTime(int id, double time)
IRM_DLL_EXPORT IRM_RESULT YAMLSetGasPhaseVolume(int id, double *gas_volume, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLInitialKinetics2Module(int id, int *kinetics, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLInitialEquilibriumPhases2Module(int id, int *equilibrium_phases, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLUseSolutionDensityVolume(int id, int tf)
IRM_DLL_EXPORT IRM_RESULT YAMLClear(int id)
IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsPPassemblage(int id, int option)
IRM_DLL_EXPORT IRM_RESULT YAMLSetPorosity(int id, double *por, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetNthSelectedOutput(int id, int n)
IRM_DLL_EXPORT IRM_RESULT YAMLFindComponents(int id)
IRM_DLL_EXPORT IRM_RESULT YAMLSetScreenOn(int id, int tf)
IRM_DLL_EXPORT IRM_RESULT YAMLSetTimeConversion(int id, double conv_factor)
IRM_DLL_EXPORT IRM_RESULT YAMLInitialSolutions2Module(int id, int *solutions, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLThreadCount(int id, int nthreads)
IRM_DLL_EXPORT IRM_RESULT YAMLCloseFiles(int id)
IRM_DLL_EXPORT IRM_RESULT YAMLSetDumpFileName(int id, const char *file_name)
IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsGasPhase(int id, int option)
IRM_DLL_EXPORT IRM_RESULT YAMLSetCurrentSelectedOutputUserNumber(int id, int n_user)
IRM_DLL_EXPORT IRM_RESULT YAMLInitialPhreeqcCell2Module(int id, int n, int *cell_numbers, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLLogMessage(int id, const char *str)
IRM_DLL_EXPORT IRM_RESULT WriteYAMLDoc(int id, const char *file_name)
IRM_DLL_EXPORT IRM_RESULT YAMLCreateMapping(int id, int *grid2chem, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLWarningMessage(int id, const char *str)
IRM_DLL_EXPORT IRM_RESULT YAMLStateDelete(int id, int istate)
IRM_DLL_EXPORT IRM_RESULT YAMLSpeciesConcentrations2Module(int id, double *species_conc, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsSolution(int id, int option)
IRM_DLL_EXPORT IRM_RESULT YAMLSetTimeStep(int id, double time_step)
IRM_DLL_EXPORT IRM_RESULT YAMLInitialGasPhases2Module(int id, int *gas_phases, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLDumpModule(int id, int dump_on, int append)
IRM_DLL_EXPORT IRM_RESULT YAMLRunString(int id, int workers, int initial_phreeqc, int utility, const char *input_string)
IRM_DLL_EXPORT IRM_RESULT YAMLSetPrintChemistryOn(int id, int workers, int initial_phreeqc, int utility)
IRM_DLL_EXPORT IRM_RESULT YAMLRunFile(int id, int workers, int initial_phreeqc, int utility, const char *file_name)
IRM_DLL_EXPORT IRM_RESULT YAMLAddOutputVars(int id, char *option, char *def)
IRM_DLL_EXPORT IRM_RESULT YAMLSetRebalanceFraction(int id, double f)
IRM_DLL_EXPORT IRM_RESULT YAMLLoadDatabase(int id, const char *database)
IRM_DLL_EXPORT IRM_RESULT YAMLSetGridCellCount(int id, int count)
IRM_DLL_EXPORT IRM_RESULT YAMLRunCells(int id)
IRM_DLL_EXPORT IRM_RESULT YAMLSetSaturationUser(int id, double *sat, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetPrintChemistryMask(int id, int *mask, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetDensityUser(int id, double *density, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetErrorOn(int id, int tf)
IRM_DLL_EXPORT IRM_RESULT YAMLSetTemperature(int id, double *tc, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsSSassemblage(int id, int option)
IRM_DLL_EXPORT IRM_RESULT YAMLInitialSolidSolutions2Module(int id, int *solid_solutions, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetGasCompMoles(int id, double *gas_moles, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLInitialSurfaces2Module(int id, int *surfaces, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLScreenMessage(int id, const char *str)
IRM_DLL_EXPORT IRM_RESULT YAMLSetSelectedOutputOn(int id, int tf)
IRM_DLL_EXPORT IRM_RESULT YAMLSetPartitionUZSolids(int id, int tf)
IRM_DLL_EXPORT int DestroyYAMLPhreeqcRM(int id)
IRM_DLL_EXPORT IRM_RESULT YAMLInitialPhreeqc2Module_mix(int id, int *ic1, int *ic2, double *f1, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetSpeciesSaveOn(int id, int save_on)
IRM_DLL_EXPORT IRM_RESULT YAMLSetPressure(int id, double *p, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetUnitsExchange(int id, int option)
IRM_DLL_EXPORT IRM_RESULT YAMLSetRepresentativeVolume(int id, double *rv, int dim)
IRM_DLL_EXPORT IRM_RESULT YAMLSetErrorHandlerMode(int id, int mode)
IRM_DLL_EXPORT IRM_RESULT YAMLSetFilePrefix(int id, const char *prefix)
IRM_DLL_EXPORT IRM_RESULT YAMLInitialExchanges2Module(int id, int *exchanges, int dim)