IPhreeqc
|
C/Fortran Documentation. More...
#include "Var.h"
Go to the source code of this file.
Enumerations | |
enum | IPQ_RESULT { IPQ_OK = 0, IPQ_OUTOFMEMORY = -1, IPQ_BADVARTYPE = -2, IPQ_INVALIDARG = -3, IPQ_INVALIDROW = -4, IPQ_INVALIDCOL = -5, IPQ_BADINSTANCE = -6 } |
Enumeration used to return error codes. More... | |
Functions | |
IPQ_RESULT | AccumulateLine (int id, const char *line) |
int | AddError (int id, const char *error_msg) |
int | AddWarning (int id, const char *warn_msg) |
IPQ_RESULT | ClearAccumulatedLines (int id) |
int | CreateIPhreeqc (void) |
IPQ_RESULT | DestroyIPhreeqc (int id) |
const char * | GetComponent (int id, int n) |
int | GetComponentCount (int id) |
int | GetCurrentSelectedOutputUserNumber (int id) |
const char * | GetDumpFileName (int id) |
int | GetDumpFileOn (int id) |
const char * | GetDumpString (int id) |
const char * | GetDumpStringLine (int id, int n) |
int | GetDumpStringLineCount (int id) |
int | GetDumpStringOn (int id) |
const char * | GetErrorFileName (int id) |
int | GetErrorFileOn (int id) |
const char * | GetErrorString (int id) |
const char * | GetErrorStringLine (int id, int n) |
int | GetErrorStringLineCount (int id) |
int | GetErrorStringOn (int id) |
const char * | GetLogFileName (int id) |
int | GetLogFileOn (int id) |
const char * | GetLogString (int id) |
const char * | GetLogStringLine (int id, int n) |
int | GetLogStringLineCount (int id) |
int | GetLogStringOn (int id) |
int | GetNthSelectedOutputUserNumber (int id, int n) |
const char * | GetOutputFileName (int id) |
int | GetOutputFileOn (int id) |
const char * | GetOutputString (int id) |
const char * | GetOutputStringLine (int id, int n) |
int | GetOutputStringLineCount (int id) |
int | GetOutputStringOn (int id) |
int | GetSelectedOutputColumnCount (int id) |
int | GetSelectedOutputCount (int id) |
const char * | GetSelectedOutputFileName (int id) |
int | GetSelectedOutputFileOn (int id) |
int | GetSelectedOutputRowCount (int id) |
const char * | GetSelectedOutputString (int id) |
const char * | GetSelectedOutputStringLine (int id, int n) |
int | GetSelectedOutputStringLineCount (int id) |
int | GetSelectedOutputStringOn (int id) |
IPQ_RESULT | GetSelectedOutputValue (int id, int row, int col, VAR *pVAR) |
IPQ_RESULT | GetSelectedOutputValue2 (int id, int row, int col, int *vtype, double *dvalue, char *svalue, unsigned int svalue_length) |
const char * | GetVersionString (void) |
const char * | GetWarningString (int id) |
const char * | GetWarningStringLine (int id, int n) |
int | GetWarningStringLineCount (int id) |
int | LoadDatabase (int id, const char *filename) |
int | LoadDatabaseString (int id, const char *input) |
void | OutputAccumulatedLines (int id) |
void | OutputErrorString (int id) |
void | OutputWarningString (int id) |
int | RunAccumulated (int id) |
int | RunFile (int id, const char *filename) |
int | RunString (int id, const char *input) |
IPQ_RESULT | SetBasicCallback (int id, double(*fcn)(double x1, double x2, const char *str, void *cookie), void *cookie1) |
IPQ_RESULT | SetBasicFortranCallback (int id, double(*fcn)(double *x1, double *x2, const char *str, int l)) |
IPQ_RESULT | SetCurrentSelectedOutputUserNumber (int id, int n) |
IPQ_RESULT | SetDumpFileName (int id, const char *filename) |
IPQ_RESULT | SetDumpFileOn (int id, int dump_on) |
IPQ_RESULT | SetDumpStringOn (int id, int dump_string_on) |
IPQ_RESULT | SetErrorFileName (int id, const char *filename) |
IPQ_RESULT | SetErrorFileOn (int id, int error_on) |
IPQ_RESULT | SetErrorStringOn (int id, int error_string_on) |
IPQ_RESULT | SetLogFileName (int id, const char *filename) |
IPQ_RESULT | SetLogFileOn (int id, int log_on) |
IPQ_RESULT | SetLogStringOn (int id, int log_string_on) |
IPQ_RESULT | SetOutputFileName (int id, const char *filename) |
IPQ_RESULT | SetOutputFileOn (int id, int output_on) |
IPQ_RESULT | SetOutputStringOn (int id, int output_string_on) |
IPQ_RESULT | SetSelectedOutputFileName (int id, const char *filename) |
IPQ_RESULT | SetSelectedOutputFileOn (int id, int sel_on) |
IPQ_RESULT | SetSelectedOutputStringOn (int id, int sel_string_on) |
C/Fortran Documentation.
enum IPQ_RESULT |
Enumeration used to return error codes.
Enumerator | |
---|---|
IPQ_OK |
Success |
IPQ_OUTOFMEMORY |
Failure, Out of memory |
IPQ_BADVARTYPE |
Failure, Invalid VAR type |
IPQ_INVALIDARG |
Failure, Invalid argument |
IPQ_INVALIDROW |
Failure, Invalid row |
IPQ_INVALIDCOL |
Failure, Invalid column |
IPQ_BADINSTANCE |
Failure, Invalid instance id |
IPQ_RESULT AccumulateLine | ( | int | id, |
const char * | line | ||
) |
Accumlulate line(s) for input to phreeqc.
id | The instance id returned from CreateIPhreeqc. |
line | The line(s) to add for input to phreeqc. |
IPQ_OK | Success |
IPQ_OUTOFMEMORY | Out of memory |
FUNCTION AccumulateLine(ID,LINE)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(IN) :: LINE
INTEGER(KIND=4) :: AccumulateLine
END FUNCTION AccumulateLine
int AddError | ( | int | id, |
const char * | error_msg | ||
) |
Appends the given error message and increments the error count. Internally used to create an error condition.
id | The instance id returned from CreateIPhreeqc. |
error_msg | The error message to display. |
FUNCTION AddError(ID,ERROR_MSG)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(IN) :: ERROR_MSG
INTEGER(KIND=4) :: AddError
END FUNCTION AddError
int AddWarning | ( | int | id, |
const char * | warn_msg | ||
) |
Appends the given warning message and increments the warning count. Internally used to create a warning condition.
id | The instance id returned from CreateIPhreeqc. |
warn_msg | The warning message to display. |
FUNCTION AddWarning(ID,WARN_MSG)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(IN) :: WARN_MSG
INTEGER(KIND=4) :: AddWarning
END FUNCTION AddWarning
IPQ_RESULT ClearAccumulatedLines | ( | int | id | ) |
Clears the accumulated input buffer. Input buffer is accumulated from calls to AccumulateLine.
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION ClearAccumulatedLines(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: ClearAccumulatedLines
END FUNCTION ClearAccumulatedLines
int CreateIPhreeqc | ( | void | ) |
Create a new IPhreeqc instance.
FUNCTION CreateIPhreeqc()
INTEGER(KIND=4) :: CreateIPhreeqc
END FUNCTION CreateIPhreeqc
IPQ_RESULT DestroyIPhreeqc | ( | int | id | ) |
Release an IPhreeqc instance from memory.
id | The instance id returned from CreateIPhreeqc. |
IPQ_OK | Success |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION DestroyIPhreeqc(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: DestroyIPhreeqc
END FUNCTION DestroyIPhreeqc
const char* GetComponent | ( | int | id, |
int | n | ||
) |
Retrieves the given component.
id | The instance id returned from CreateIPhreeqc. |
n | The zero-based index of the component to retrieve. |
SUBROUTINE GetComponent(ID,N,COMP)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4), INTENT(IN) :: N
CHARACTER(LEN=*), INTENT(OUT) :: COMP
END SUBROUTINE GetComponent
int GetComponentCount | ( | int | id | ) |
Retrieves the number of components in the current component list.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetComponentCount(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetComponentCount
END FUNCTION GetComponentCount
int GetCurrentSelectedOutputUserNumber | ( | int | id | ) |
Retrieves the current SELECTED_OUTPUT user number for use in subsequent calls to (GetSelectedOutputColumnCount, GetSelectedOutputFileName, GetSelectedOutputRowCount, GetSelectedOutputString, GetSelectedOutputStringLine, GetSelectedOutputStringLineCount, GetSelectedOutputValue, GetSelectedOutputValue2) routines. The initial setting after calling CreateIPhreeqc is 1.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetCurrentSelectedOutputUserNumber(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetCurrentSelectedOutputUserNumber
END FUNCTION GetCurrentSelectedOutputUserNumber
const char* GetDumpFileName | ( | int | id | ) |
Retrieves the name of the dump file. This file name is used if not specified within DUMP input. The default value is dump.id.out.
id | The instance id returned from CreateIPhreeqc. |
SUBROUTINE GetDumpFileName(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(OUT) :: FILENAME
END SUBROUTINE GetDumpFileName
int GetDumpFileOn | ( | int | id | ) |
Retrieves the current value of the dump file switch.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetDumpFileOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetDumpFileOn
END FUNCTION GetDumpFileOn
const char* GetDumpString | ( | int | id | ) |
Retrieves the string buffer containing DUMP output.
id | The instance id returned from CreateIPhreeqc. |
const char* GetDumpStringLine | ( | int | id, |
int | n | ||
) |
Retrieves the given dump line.
id | The instance id returned from CreateIPhreeqc. |
n | The zero-based index of the line to retrieve. |
SUBROUTINE GetDumpStringLine(ID,N,LINE)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4), INTENT(IN) :: N
CHARACTER(LEN=*), INTENT(OUT) :: LINE
END SUBROUTINE GetDumpStringLine
int GetDumpStringLineCount | ( | int | id | ) |
Retrieves the number of lines in the current dump string buffer.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetDumpStringLineCount(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetDumpStringLineCount
END FUNCTION GetDumpStringLineCount
int GetDumpStringOn | ( | int | id | ) |
Retrieves the current value of the dump string switch.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetDumpStringOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetDumpStringOn
END FUNCTION GetDumpStringOn
const char* GetErrorFileName | ( | int | id | ) |
Retrieves the name of the error file. The default name is phreeqc.id.err.
id | The instance id returned from CreateIPhreeqc. |
SUBROUTINE GetErrorFileName(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(OUT) :: FILENAME
END SUBROUTINE GetErrorFileName
int GetErrorFileOn | ( | int | id | ) |
Retrieves the current value of the error file switch.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetErrorFileOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetErrorFileOn
END FUNCTION GetErrorFileOn
const char* GetErrorString | ( | int | id | ) |
Retrieves the error messages from the last call to RunAccumulated, RunFile, RunString, LoadDatabase, or LoadDatabaseString.
id | The instance id returned from CreateIPhreeqc. |
const char* GetErrorStringLine | ( | int | id, |
int | n | ||
) |
Retrieves the given error line.
id | The instance id returned from CreateIPhreeqc. |
n | The zero-based index of the line to retrieve. |
SUBROUTINE GetErrorStringLine(ID,N,LINE)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4), INTENT(IN) :: N
CHARACTER(LEN=*), INTENT(OUT) :: LINE
END SUBROUTINE GetErrorStringLine
int GetErrorStringLineCount | ( | int | id | ) |
Retrieves the number of lines in the current error string buffer.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetErrorStringLineCount(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetErrorStringLineCount
END FUNCTION GetErrorStringLineCount
int GetErrorStringOn | ( | int | id | ) |
Retrieves the current value of the error string switch.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetErrorStringOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetErrorStringOn
END FUNCTION GetErrorStringOn
const char* GetLogFileName | ( | int | id | ) |
Retrieves the name of the log file. The default name is phreeqc.id.log.
id | The instance id returned from CreateIPhreeqc. |
SUBROUTINE GetLogFileName(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(OUT) :: FILENAME
END SUBROUTINE GetLogFileName
int GetLogFileOn | ( | int | id | ) |
Retrieves the current value of the log file switch.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetLogFileOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetLogFileOn
END FUNCTION GetLogFileOn
const char* GetLogString | ( | int | id | ) |
Retrieves the string buffer containing log output.
id | The instance id returned from CreateIPhreeqc. |
const char* GetLogStringLine | ( | int | id, |
int | n | ||
) |
Retrieves the given log line.
id | The instance id returned from CreateIPhreeqc. |
n | The zero-based index of the line to retrieve. |
SUBROUTINE GetLogStringLine(ID,N,LINE)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4), INTENT(IN) :: N
CHARACTER(LEN=*), INTENT(OUT) :: LINE
END SUBROUTINE GetLogStringLine
int GetLogStringLineCount | ( | int | id | ) |
Retrieves the number of lines in the current log string buffer.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetLogStringLineCount(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetLogStringLineCount
END FUNCTION GetLogStringLineCount
int GetLogStringOn | ( | int | id | ) |
Retrieves the current value of the log string switch.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetLogStringOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetLogStringOn
END FUNCTION GetLogStringOn
int GetNthSelectedOutputUserNumber | ( | int | id, |
int | n | ||
) |
Retrieves the nth user number of the currently defined SELECTED_OUTPUT keyword blocks.
id | The instance id returned from CreateIPhreeqc. |
n | The zero-based index of the SELECTED_OUTPUT user number to retrieve. |
FUNCTION GetNthSelectedOutputUserNumber(ID,N)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4), INTENT(IN) :: N
INTEGER(KIND=4) :: GetNthSelectedOutputUserNumber
END FUNCTION GetNthSelectedOutputUserNumber
const char* GetOutputFileName | ( | int | id | ) |
Retrieves the name of the output file. The default name is phreeqc.id.out.
id | The instance id returned from CreateIPhreeqc. |
SUBROUTINE GetOutputFileName(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(OUT) :: FILENAME
END SUBROUTINE GetOutputFileName
int GetOutputFileOn | ( | int | id | ) |
Retrieves the current value of the output file switch.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetOutputFileOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetOutputFileOn
END FUNCTION GetOutputFileOn
const char* GetOutputString | ( | int | id | ) |
Retrieves the string buffer containing phreeqc output.
id | The instance id returned from CreateIPhreeqc. |
const char* GetOutputStringLine | ( | int | id, |
int | n | ||
) |
Retrieves the given output line.
id | The instance id returned from CreateIPhreeqc. |
n | The zero-based index of the line to retrieve. |
SUBROUTINE GetOutputStringLine(ID,N,LINE)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4), INTENT(IN) :: N
CHARACTER(LEN=*), INTENT(OUT) :: LINE
END SUBROUTINE GetOutputStringLine
int GetOutputStringLineCount | ( | int | id | ) |
Retrieves the number of lines in the current output string buffer.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetOutputStringLineCount(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetOutputStringLineCount
END FUNCTION GetOutputStringLineCount
int GetOutputStringOn | ( | int | id | ) |
Retrieves the current value of the output string switch.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetOutputStringOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetOutputStringOn
END FUNCTION GetOutputStringOn
int GetSelectedOutputColumnCount | ( | int | id | ) |
Retrieves the number of columns in the selected-output buffer.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetSelectedOutputColumnCount(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetSelectedOutputColumnCount
END FUNCTION GetSelectedOutputColumnCount
int GetSelectedOutputCount | ( | int | id | ) |
Retrieves the count of SELECTED_OUTPUT blocks that are currently defined.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetSelectedOutputCount(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetSelectedOutputCount
END FUNCTION GetSelectedOutputCount
const char* GetSelectedOutputFileName | ( | int | id | ) |
Retrieves the name of the current selected output file (see SetCurrentSelectedOutputUserNumber). This file name is used if not specified within SELECTED_OUTPUT input. The default value is selected_n.id.out.
id | The instance id returned from CreateIPhreeqc. |
SUBROUTINE GetSelectedOutputFileName(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(OUT) :: FILENAME
END SUBROUTINE GetSelectedOutputFileName
int GetSelectedOutputFileOn | ( | int | id | ) |
Retrieves the current selected-output file switch (see SetCurrentSelectedOutputUserNumber).
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetSelectedOutputFileOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetSelectedOutputFileOn
END FUNCTION GetSelectedOutputFileOn
int GetSelectedOutputRowCount | ( | int | id | ) |
Retrieves the number of rows in the current selected-output buffer (see SetCurrentSelectedOutputUserNumber).
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetSelectedOutputRowCount(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetSelectedOutputRowCount
END FUNCTION GetSelectedOutputRowCount
const char* GetSelectedOutputString | ( | int | id | ) |
Retrieves the string buffer containing the current SELECTED_OUTPUT (see SetCurrentSelectedOutputUserNumber).
id | The instance id returned from CreateIPhreeqc. |
const char* GetSelectedOutputStringLine | ( | int | id, |
int | n | ||
) |
Retrieves the given line of the current selected output string (see SetCurrentSelectedOutputUserNumber).
id | The instance id returned from CreateIPhreeqc. |
n | The zero-based index of the line to retrieve. |
SUBROUTINE GetSelectedOutputStringLine(ID,N,LINE)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4), INTENT(IN) :: N
CHARACTER(LEN=*), INTENT(OUT) :: LINE
END SUBROUTINE GetSelectedOutputStringLine
int GetSelectedOutputStringLineCount | ( | int | id | ) |
Retrieves the number of lines in the current selected output string buffer (see SetCurrentSelectedOutputUserNumber).
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetSelectedOutputStringLineCount(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetSelectedOutputStringLineCount
END FUNCTION GetSelectedOutputStringLineCount
int GetSelectedOutputStringOn | ( | int | id | ) |
Retrieves the value of the current selected output string switch (see SetCurrentSelectedOutputUserNumber).
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetSelectedOutputStringOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetSelectedOutputStringOn
END FUNCTION GetSelectedOutputStringOn
IPQ_RESULT GetSelectedOutputValue | ( | int | id, |
int | row, | ||
int | col, | ||
VAR * | pVAR | ||
) |
Returns the VAR
associated with the specified row and column. The current SELECTED_OUTPUT block is set using the SetCurrentSelectedOutputUserNumber method.
id | The instance id returned from CreateIPhreeqc. |
row | The row index. |
col | The column index. |
pVAR | Pointer to the VAR to receive the requested data. |
IPQ_OK | Success. |
IPQ_INVALIDROW | The given row is out of range. |
IPQ_INVALIDCOL | The given column is out of range. |
IPQ_OUTOFMEMORY | Memory could not be allocated. |
IPQ_BADINSTANCE | The given id is invalid. |
Input | Headings |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
FUNCTION GetSelectedOutputValue(ID,ROW,COL,VTYPE,DVALUE,SVALUE,SLENGTH)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4), INTENT(IN) :: ROW
INTEGER(KIND=4), INTENT(IN) :: COL
INTEGER(KIND=4), INTENT(OUT) :: VTYPE
REAL(KIND=8), INTENT(OUT) :: DVALUE
CHARACTER(LEN=*), INTENT(OUT) :: SVALUE
INTEGER(KIND=4), INTENT(OUT), OPTIONAL :: SLENGTH
INTEGER(KIND=4) :: GetSelectedOutputValue
END FUNCTION GetSelectedOutputValue
ID | The instance id returned from CreateIPhreeqc. |
ROW | The row index. |
COL | The column index. |
VTYPE | Returns the variable type. See VAR_TYPE. |
DVALUE | Returns the numeric value when (VTYPE=TT_DOUBLE) or (VTYPE=TT_LONG). |
SVALUE | Returns the string variable when (VTYPE=TT_STRING). When (VTYPE=TT_DOUBLE) or (VTYPE=TT_LONG) this variable is filled with a string equivalent of DVALUE. |
SLENGTH | Optional, if the length of SVALUE isn't sufficient to hold the entire string value, returns the required length, otherwise returns 0 (zero). |
IPQ_RESULT GetSelectedOutputValue2 | ( | int | id, |
int | row, | ||
int | col, | ||
int * | vtype, | ||
double * | dvalue, | ||
char * | svalue, | ||
unsigned int | svalue_length | ||
) |
Returns the associated data with the specified row and column. The current SELECTED_OUTPUT block is set using the SetCurrentSelectedOutputUserNumber method.
id | The instance id returned from CreateIPhreeqc. |
row | The row index. |
col | The column index. |
vtype | Receives the variable type. See VAR_TYPE. |
dvalue | Receives the numeric value when (VTYPE=TT_DOUBLE) or (VTYPE=TT_LONG). |
svalue | Receives the string variable when (VTYPE=TT_STRING). When (VTYPE=TT_DOUBLE) or (VTYPE=TT_LONG) this variable is filled with a string equivalent of DVALUE. |
svalue_length | The length of the svalue buffer. |
IPQ_OK | Success. |
IPQ_INVALIDROW | The given row is out of range. |
IPQ_INVALIDCOL | The given column is out of range. |
IPQ_OUTOFMEMORY | Memory could not be allocated. |
IPQ_BADINSTANCE | The given id is invalid. |
Input | Headings |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
const char* GetVersionString | ( | void | ) |
Retrieves the string buffer containing the version in the form of X.X.X-XXXX.
SUBROUTINE GetVersionString(VERSION)
CHARACTER(LEN=*), INTENT(OUT) :: VERSION
END SUBROUTINE GetVersionString
const char* GetWarningString | ( | int | id | ) |
Retrieves the warning messages from the last call to (RunAccumulated, RunFile, RunString, LoadDatabase, or LoadDatabaseString).
id | The instance id returned from CreateIPhreeqc. |
const char* GetWarningStringLine | ( | int | id, |
int | n | ||
) |
Retrieves the given warning line.
id | The instance id returned from CreateIPhreeqc. |
n | The zero-based index of the line to retrieve. |
SUBROUTINE GetWarningStringLine(ID,N,LINE)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: N
CHARACTER(LEN=*), INTENT(OUT) :: LINE
END SUBROUTINE GetWarningStringLine
int GetWarningStringLineCount | ( | int | id | ) |
Retrieves the number of lines in the current warning string buffer.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION GetWarningStringLineCount(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: GetWarningStringLineCount
END FUNCTION GetWarningStringLineCount
int LoadDatabase | ( | int | id, |
const char * | filename | ||
) |
Load the specified database file into phreeqc.
id | The instance id returned from CreateIPhreeqc. |
filename | The name of the phreeqc database to load. The full path (or relative path with respect to the working directory) must be given if the file is not in the current working directory. |
FUNCTION LoadDatabase(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(IN) :: FILENAME
INTEGER(KIND=4) :: LoadDatabase
END FUNCTION LoadDatabase
int LoadDatabaseString | ( | int | id, |
const char * | input | ||
) |
Load the specified string as a database into phreeqc.
id | The instance id returned from CreateIPhreeqc. |
input | String containing data to be used as the phreeqc database. |
FUNCTION LoadDatabaseString(ID,INPUT)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(IN) :: INPUT
INTEGER(KIND=4) :: LoadDatabaseString
END FUNCTION LoadDatabaseString
void OutputAccumulatedLines | ( | int | id | ) |
Output the accumulated input buffer to stdout. This input buffer can be run with a call to RunAccumulated.
id | The instance id returned from CreateIPhreeqc. |
SUBROUTINE OutputAccumulatedLines(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
END SUBROUTINE OutputAccumulatedLines
void OutputErrorString | ( | int | id | ) |
Output the error messages normally stored in the phreeqc.id.err file to stdout.
id | The instance id returned from CreateIPhreeqc. |
SUBROUTINE OutputErrorString(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
END SUBROUTINE OutputErrorString
void OutputWarningString | ( | int | id | ) |
Output the warning messages to stdout.
id | The instance id returned from CreateIPhreeqc. |
SUBROUTINE OutputWarningString(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
END SUBROUTINE OutputWarningString
int RunAccumulated | ( | int | id | ) |
Runs the input buffer as defined by calls to AccumulateLine.
id | The instance id returned from CreateIPhreeqc. |
FUNCTION RunAccumulated(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: RunAccumulated
END FUNCTION RunAccumulated
int RunFile | ( | int | id, |
const char * | filename | ||
) |
Runs the specified phreeqc input file.
id | The instance id returned from CreateIPhreeqc. |
filename | The name of the phreeqc input file to run. |
FUNCTION RunFile(ID,FNAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(IN) :: FNAME
INTEGER(KIND=4) :: RunFile
END FUNCTION RunFile
int RunString | ( | int | id, |
const char * | input | ||
) |
Runs the specified string as input to phreeqc.
id | The instance id returned from CreateIPhreeqc. |
input | String containing phreeqc input. |
FUNCTION RunString(ID,INPUT)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(IN) :: INPUT
INTEGER(KIND=4) :: RunString
END FUNCTION RunString
IPQ_RESULT SetBasicCallback | ( | int | id, |
double(*)(double x1, double x2, const char *str, void *cookie) | fcn, | ||
void * | cookie1 | ||
) |
Sets a C callback function for Basic programs. The syntax for the Basic command is 10 result = CALLBACK(x1, x2, string$) The syntax for the C function is double my_callback(double x1, double x2, const char * string)
id | The instance id returned from CreateIPhreeqc. |
fcn | The name of a user-defined function. |
cookie1 | A user defined value to be passed to the callback function. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
IPQ_RESULT SetBasicFortranCallback | ( | int | id, |
double(*)(double *x1, double *x2, const char *str, int l) | fcn | ||
) |
Sets a Fortran callback function for Basic programs. The syntax for the Basic command is 10 result = CALLBACK(x1, x2, string$) The syntax for the Fortran function is REAL(KIND=C_DOUBLE) my_callback(x1, x2, string), where x1 and x2 are REAL(KIND=C_DOUBLE) and string is a CHARACTER(KIND=C_CHAR).
id | The instance id returned from CreateIPhreeqc. |
fcn | The name of a REAL(KIND=C_DOUBLE) Fortran function with three arguments (two REAL(KIND=C_DOUBLE), and one CHARACTER(KIND=C_CHAR)). |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
!
! if using include files (IPhreeqc.f.inc or IPhreeqc.f90.inc)
!
#ifdef IPHREEQC_NO_FORTRAN_MODULE
FUNCTION SetBasicFortranCallback(ID,FCN)
INTEGER(KIND=4), INTENT(IN) :: ID
INTERFACE
DOUBLE PRECISION FUNCTION FCN(x1, x2, str)
DOUBLE PRECISION, INTENT(in) :: x1
DOUBLE PRECISION, INTENT(in) :: x2
CHARACTER(*), INTENT(in) :: str
END FUNCTION
END INTERFACE
INTEGER(KIND=4) :: SetBasicFortranCallback
END FUNCTION SetBasicFortranCallback
#else
!
! if using the fortran module (USE IPhreeqc)
! must also add IPhreeqc_interface.F90 to your project
!
FUNCTION SetBasicFortranCallback(ID,FCN)
INTEGER(KIND=4), INTENT(IN) :: ID
INTERFACE
REAL(KIND=C_DOUBLE) FUNCTION fcn(x1, x2, str, l) BIND(C)
USE ISO_C_BINDING
IMPLICIT none
REAL(KIND=C_DOUBLE), INTENT(in) :: x1, x2
CHARACTER(KIND=C_CHAR), INTENT(in) :: str(*)
INTEGER(KIND=C_INT), INTENT(in), VALUE :: l
END FUNCTION fcn
END INTERFACE
END FUNCTION SetBasicFortranCallback
#endif
IPQ_RESULT SetCurrentSelectedOutputUserNumber | ( | int | id, |
int | n | ||
) |
Sets the current SELECTED_OUTPUT user number for use in subsequent calls to (GetSelectedOutputColumnCount, GetSelectedOutputFileName, GetSelectedOutputRowCount, GetSelectedOutputString, GetSelectedOutputStringLine, GetSelectedOutputStringLineCount, GetSelectedOutputValue, GetSelectedOutputValue2) routines. The initial setting after calling CreateIPhreeqc is 1.
id | The instance id returned from CreateIPhreeqc. |
n | The user number specified in the SELECTED_OUTPUT block. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
IPQ_INVALIDARG | The given user number is invalid. |
FUNCTION SetCurrentSelectedOutputUserNumber(ID,N)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4), INTENT(IN) :: N
INTEGER(KIND=4) :: SetCurrentSelectedOutputUserNumber
END FUNCTION SetCurrentSelectedOutputUserNumber
IPQ_RESULT SetDumpFileName | ( | int | id, |
const char * | filename | ||
) |
Sets the name of the dump file. This file name is used if not specified within DUMP input. The default value is dump.id.out.
id | The instance id returned from CreateIPhreeqc. |
filename | The name of the file to write DUMP output to. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetDumpFileName(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(OUT) :: FILENAME
INTEGER(KIND=4) :: SetDumpFileName
END FUNCTION SetDumpFileName
IPQ_RESULT SetDumpFileOn | ( | int | id, |
int | dump_on | ||
) |
Sets the dump file switch on or off. This switch controls whether or not phreeqc writes to the dump file. The initial setting after calling CreateIPhreeqc is off.
id | The instance id returned from CreateIPhreeqc. |
dump_on | If non-zero, turns on output to the DUMP (dump.id.out if unspecified) file; if zero, turns off output to the DUMP file. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetDumpFileOn(ID,DUMP_ON)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: DUMP_ON
INTEGER(KIND=4) :: SetDumpFileOn
END FUNCTION SetDumpFileOn
IPQ_RESULT SetDumpStringOn | ( | int | id, |
int | dump_string_on | ||
) |
Sets the dump string switch on or off. This switch controls whether or not the data normally sent to the dump file are stored in a buffer for retrieval. The initial setting after calling CreateIPhreeqc is off.
id | The instance id returned from CreateIPhreeqc. |
dump_string_on | If non-zero, captures the output defined by the DUMP keyword into a string buffer; if zero, output defined by the DUMP keyword is not captured to a string buffer. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetDumpStringOn(ID,DUMP_STRING_ON)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: DUMP_STRING_ON
INTEGER(KIND=4) :: SetDumpStringOn
END FUNCTION SetDumpStringOn
IPQ_RESULT SetErrorFileName | ( | int | id, |
const char * | filename | ||
) |
Sets the name of the error file. The default value is phreeqc.id.err.
id | The instance id returned from CreateIPhreeqc. |
filename | The name of the error file. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetErrorFileName(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(OUT) :: FILENAME
INTEGER(KIND=4) :: SetErrorFileName
END FUNCTION SetErrorFileName
IPQ_RESULT SetErrorFileOn | ( | int | id, |
int | error_on | ||
) |
Sets the error file switch on or off. This switch controls whether or not error messages are written to the phreeqc.id.err file. The initial setting after calling CreateIPhreeqc is off.
id | The instance id returned from CreateIPhreeqc. |
error_on | If non-zero, writes errors to the error file; if zero, no errors are written to the error file. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetErrorFileOn(ID,ERR_ON)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: ERR_ON
INTEGER(KIND=4) :: SetErrorFileOn
END FUNCTION SetErrorFileOn
IPQ_RESULT SetErrorStringOn | ( | int | id, |
int | error_string_on | ||
) |
Sets the error string switch on or off. This switch controls whether or not the data normally sent to the error file are stored in a buffer for retrieval. The initial setting after calling CreateIPhreeqc is on.
id | The instance id returned from CreateIPhreeqc. |
error_string_on | If non-zero, captures the error output into a string buffer; if zero, error output is not captured to a string buffer. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetErrorStringOn(ID,ERR_STRING_ON)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: ERR_STRING_ON
INTEGER(KIND=4) :: SetErrorStringOn
END FUNCTION SetErrorStringOn
IPQ_RESULT SetLogFileName | ( | int | id, |
const char * | filename | ||
) |
Sets the name of the log file. The default value is phreeqc.id.log.
id | The instance id returned from CreateIPhreeqc. |
filename | The name of the log file. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetLogFileName(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(OUT) :: FILENAME
INTEGER(KIND=4) :: SetLogFileName
END FUNCTION SetLogFileName
IPQ_RESULT SetLogFileOn | ( | int | id, |
int | log_on | ||
) |
Sets the log file switch on or off. This switch controls whether or not phreeqc writes log messages to the phreeqc.id.log file. The initial setting after calling CreateIPhreeqc is off.
id | The instance id returned from CreateIPhreeqc. |
log_on | If non-zero, log messages are written to the log file; if zero, no log messages are written to the log file. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetLogFileOn(ID,LOG_ON)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: LOG_ON
INTEGER(KIND=4) :: SetLogFileOn
END FUNCTION SetLogFileOn
IPQ_RESULT SetLogStringOn | ( | int | id, |
int | log_string_on | ||
) |
Sets the log string switch on or off. This switch controls whether or not the data normally sent to the log file are stored in a buffer for retrieval. The initial setting after calling CreateIPhreeqc is off.
id | The instance id returned from CreateIPhreeqc. |
log_string_on | If non-zero, captures the log output into a string buffer; if zero, log output is not captured to a string buffer. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetLogStringOn(ID,LOG_STRING_ON)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: LOG_STRING_ON
INTEGER(KIND=4) :: SetLogStringOn
END FUNCTION SetLogStringOn
IPQ_RESULT SetOutputFileName | ( | int | id, |
const char * | filename | ||
) |
Sets the name of the output file. This file name is used if not specified within DUMP input. The default value is phreeqc.id.out.
id | The instance id returned from CreateIPhreeqc. |
filename | The name of the phreeqc output file. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetOutputFileName(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(OUT) :: FILENAME
INTEGER(KIND=4) :: SetOutputFileName
END FUNCTION SetOutputFileName
IPQ_RESULT SetOutputFileOn | ( | int | id, |
int | output_on | ||
) |
Sets the output file switch on or off. This switch controls whether or not phreeqc writes to the phreeqc.id.out file. This is the output normally generated when phreeqc is run. The initial setting after calling CreateIPhreeqc is off.
id | The instance id returned from CreateIPhreeqc. |
output_on | If non-zero, writes output to the output file; if zero, no output is written to the output file. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetOutputFileOn(ID,OUT_ON)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: OUT_ON
INTEGER(KIND=4) :: SetOutputFileOn
END FUNCTION SetOutputFileOn
IPQ_RESULT SetOutputStringOn | ( | int | id, |
int | output_string_on | ||
) |
Sets the output string switch on or off. This switch controls whether or not the data normally sent to the output file are stored in a buffer for retrieval. The initial setting after calling CreateIPhreeqc is off.
id | The instance id returned from CreateIPhreeqc. |
output_string_on | If non-zero, captures the phreeqc output into a string buffer; if zero, phreeqc output is not captured to a string buffer. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetOutputStringOn(ID,OUTPUT_STRING_ON)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: OUTPUT_STRING_ON
INTEGER(KIND=4) :: SetOutputStringOn
END FUNCTION SetOutputStringOn
IPQ_RESULT SetSelectedOutputFileName | ( | int | id, |
const char * | filename | ||
) |
Sets the name of the current selected output file (see SetCurrentSelectedOutputUserNumber). This file name is used if not specified within SELECTED_OUTPUT input. The default value is selected_n.id.out.
id | The instance id returned from CreateIPhreeqc. |
filename | The name of the file to write SELECTED_OUTPUT output to. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetSelectedOutputFileName(ID,FILENAME)
INTEGER(KIND=4), INTENT(IN) :: ID
CHARACTER(LEN=*), INTENT(OUT) :: FILENAME
INTEGER(KIND=4) :: SetSelectedOutputFileName
END FUNCTION SetSelectedOutputFileName
IPQ_RESULT SetSelectedOutputFileOn | ( | int | id, |
int | sel_on | ||
) |
Sets the selected-output file switch on or off. This switch controls whether or not phreeqc writes output to the current SELECTED_OUTPUT file (see SetCurrentSelectedOutputUserNumber). The initial setting after calling CreateIPhreeqc is off.
id | The instance id returned from CreateIPhreeqc. |
sel_on | If non-zero, writes output to the selected-output file; if zero, no output is written to the selected-output file. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetSelectedOutputFileOn(ID,SEL_ON)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: SEL_ON
INTEGER(KIND=4) :: SetSelectedOutputFileOn
END FUNCTION SetSelectedOutputFileOn
IPQ_RESULT SetSelectedOutputStringOn | ( | int | id, |
int | sel_string_on | ||
) |
Sets the current selected output string switch on or off. This switch controls whether or not the data normally sent to the current selected output file (see SetCurrentSelectedOutputUserNumber) are stored in a buffer for retrieval. The initial setting after calling CreateIPhreeqc is off.
id | The instance id returned from CreateIPhreeqc. |
sel_string_on | If non-zero, captures the output defined by the SELECTED_OUTPUT keyword into a string buffer; if zero, output defined by the SELECTED_OUTPUT keyword is not captured to a string buffer. |
IPQ_OK | Success. |
IPQ_BADINSTANCE | The given id is invalid. |
FUNCTION SetSelectedOutputStringOn(ID,SELECTED_OUTPUT_STRING_ON)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4), INTENT(IN) :: SELECTED_OUTPUT_STRING_ON
INTEGER(KIND=4) :: SetSelectedOutputStringOn
END FUNCTION SetSelectedOutputStringOn