max/iphreeqc
1
0
Fork 0
mirror of https://git.gfz-potsdam.de/naaice/iphreeqc.git synced 2025-12-16 08:38:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

updated documentation

Browse Source 
git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@4472 1feff8c3-07ed-0310-ac33-dd36852eb9cd
This commit is contained in:
Scott R Charlton 2010-05-27 04:13:34 +00:00
parent 36cc016ac8
commit e80e834067
4 changed files with 87 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/IPhreeqc.f.inc
View File

@ -45,16 +45,17 @@ C
INTEGER(KIND=4) AccumulateLine INTEGER(KIND=4) AccumulateLine
INTEGER(KIND=4) AddError INTEGER(KIND=4) AddError
INTEGER(KIND=4) AddWarning INTEGER(KIND=4) AddWarning
INTEGER(KIND=4) ClearAccumulatedLines
INTEGER(KIND=4) CreateIPhreeqc INTEGER(KIND=4) CreateIPhreeqc
INTEGER(KIND=4) DestroyIPhreeqc INTEGER(KIND=4) DestroyIPhreeqc
INTEGER(KIND=4) GetComponentCount INTEGER(KIND=4) GetComponentCount
LOGICAL(KIND=4) GetDumpFileOn
INTEGER(KIND=4) GetDumpStringLine INTEGER(KIND=4) GetDumpStringLine
INTEGER(KIND=4) GetDumpStringLineCount INTEGER(KIND=4) GetDumpStringLineCount
LOGICAL(KIND=4) GetDumpFileOn
LOGICAL(KIND=4) GetDumpStringOn LOGICAL(KIND=4) GetDumpStringOn
LOGICAL(KIND=4) GetErrorFileOn
INTEGER(KIND=4) GetErrorStringLine INTEGER(KIND=4) GetErrorStringLine
INTEGER(KIND=4) GetErrorStringLineCount INTEGER(KIND=4) GetErrorStringLineCount
LOGICAL(KIND=4) GetErrorFileOn
LOGICAL(KIND=4) GetLogFileOn LOGICAL(KIND=4) GetLogFileOn
LOGICAL(KIND=4) GetOutputFileOn LOGICAL(KIND=4) GetOutputFileOn
INTEGER(KIND=4) GetSelectedOutputColumnCount INTEGER(KIND=4) GetSelectedOutputColumnCount

40
include/IPhreeqc.f90.inc
View File

@ -42,6 +42,14 @@
END INTERFACE END INTERFACE
INTERFACE
FUNCTION ClearAccumulatedLines(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
INTEGER(KIND=4) :: ClearAccumulatedLines
END FUNCTION ClearAccumulatedLines
END INTERFACE
INTERFACE INTERFACE
FUNCTION CreateIPhreeqc() FUNCTION CreateIPhreeqc()
INTEGER(KIND=4) :: CreateIPhreeqc INTEGER(KIND=4) :: CreateIPhreeqc
@ -74,6 +82,14 @@
END INTERFACE END INTERFACE
INTERFACE
FUNCTION GetDumpFileOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetDumpFileOn
END FUNCTION GetDumpFileOn
END INTERFACE
INTERFACE INTERFACE
SUBROUTINE GetDumpStringLine(ID,N,LINE) SUBROUTINE GetDumpStringLine(ID,N,LINE)
INTEGER(KIND=4), INTENT(IN) :: ID INTEGER(KIND=4), INTENT(IN) :: ID
@ -91,14 +107,6 @@
END INTERFACE END INTERFACE
INTERFACE
FUNCTION GetDumpFileOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetDumpFileOn
END FUNCTION GetDumpFileOn
END INTERFACE
INTERFACE INTERFACE
FUNCTION GetDumpStringOn(ID) FUNCTION GetDumpStringOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID INTEGER(KIND=4), INTENT(IN) :: ID
@ -107,6 +115,14 @@
END INTERFACE END INTERFACE
INTERFACE
FUNCTION GetErrorFileOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetErrorFileOn
END FUNCTION GetErrorFileOn
END INTERFACE
INTERFACE INTERFACE
SUBROUTINE GetErrorStringLine(ID,N,LINE) SUBROUTINE GetErrorStringLine(ID,N,LINE)
INTEGER(KIND=4), INTENT(IN) :: ID INTEGER(KIND=4), INTENT(IN) :: ID
@ -124,14 +140,6 @@
END INTERFACE END INTERFACE
INTERFACE
FUNCTION GetErrorFileOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID
LOGICAL(KIND=4) :: GetErrorFileOn
END FUNCTION GetErrorFileOn
END INTERFACE
INTERFACE INTERFACE
FUNCTION GetLogFileOn(ID) FUNCTION GetLogFileOn(ID)
INTEGER(KIND=4), INTENT(IN) :: ID INTEGER(KIND=4), INTENT(IN) :: ID

66
include/IPhreeqc.h
View File

@ -34,7 +34,7 @@ extern "C" {
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION AccumulateLine(LINE) * FUNCTION AccumulateLine(ID,LINE)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* CHARACTER(LEN=*), INTENT(IN) :: LINE * CHARACTER(LEN=*), INTENT(IN) :: LINE
* INTEGER(KIND=4) :: AccumulateLine * INTEGER(KIND=4) :: AccumulateLine
@ -104,6 +104,17 @@ extern "C" {
* @retval IPQ_OK Success. * @retval IPQ_OK Success.
* @retval IPQ_BADINSTANCE The given id is invalid. * @retval IPQ_BADINSTANCE The given id is invalid.
* @see AccumulateLine, OutputAccumulatedLines, RunAccumulated * @see AccumulateLine, OutputAccumulatedLines, RunAccumulated
* @par Fortran90 Interface:
* @htmlonly
* <CODE>
* <PRE>
* FUNCTION ClearAccumulatedLines(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID
* INTEGER(KIND=4) :: ClearAccumulatedLines
* END FUNCTION ClearAccumulatedLines
* </PRE>
* </CODE>
* @endhtmlonly
*/ */
IPQ_DLL_EXPORT IPQ_RESULT ClearAccumulatedLines(int id); IPQ_DLL_EXPORT IPQ_RESULT ClearAccumulatedLines(int id);
@ -229,10 +240,10 @@ extern "C" {
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION GetDumpFileOn(DUMP_ON) * FUNCTION GetDumpFileOn(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* LOGICAL(KIND=4) :: GetDumpFileOn * LOGICAL(KIND=4) :: GetDumpFileOn
* END FUNCTION SetDumpFileOn * END FUNCTION GetDumpFileOn
* </PRE> * </PRE>
* </CODE> * </CODE>
* @endhtmlonly * @endhtmlonly
@ -273,7 +284,7 @@ extern "C" {
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* INTEGER(KIND=4), INTENT(IN) :: N * INTEGER(KIND=4), INTENT(IN) :: N
* CHARACTER(LEN=*), INTENT(OUT) :: LINE * CHARACTER(LEN=*), INTENT(OUT) :: LINE
* END SUBROUTINE GetComponent * END SUBROUTINE GetDumpStringLine
* </PRE> * </PRE>
* </CODE> * </CODE>
* @endhtmlonly * @endhtmlonly
@ -318,7 +329,7 @@ extern "C" {
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION GetDumpStringOn(DUMP_STRING_ON) * FUNCTION GetDumpStringOn(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* LOGICAL(KIND=4) :: GetDumpStringOn * LOGICAL(KIND=4) :: GetDumpStringOn
* END FUNCTION GetDumpStringOn * END FUNCTION GetDumpStringOn
@ -338,7 +349,7 @@ extern "C" {
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION GetErrorFileOn(ERROR_ON) * FUNCTION GetErrorFileOn(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* LOGICAL(KIND=4) :: GetErrorFileOn * LOGICAL(KIND=4) :: GetErrorFileOn
* END FUNCTION GetErrorFileOn * END FUNCTION GetErrorFileOn
@ -371,7 +382,7 @@ extern "C" {
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* SUBROUTINE GetErrorStringLine * SUBROUTINE GetErrorStringLine(ID,N,LINE)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* INTEGER(KIND=4), INTENT(IN) :: N * INTEGER(KIND=4), INTENT(IN) :: N
* CHARACTER(LEN=*), INTENT(OUT) :: LINE * CHARACTER(LEN=*), INTENT(OUT) :: LINE
@ -392,7 +403,7 @@ extern "C" {
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION GetErrorStringLineCount * FUNCTION GetErrorStringLineCount(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* INTEGER(KIND=4) :: GetErrorStringLineCount * INTEGER(KIND=4) :: GetErrorStringLineCount
* END FUNCTION GetErrorStringLineCount * END FUNCTION GetErrorStringLineCount
@ -436,6 +447,7 @@ extern "C" {
* <PRE> * <PRE>
* FUNCTION GetOutputFileOn(ID) * FUNCTION GetOutputFileOn(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* LOGICAL(KIND=4) :: GetOutputFileOn
* END FUNCTION GetOutputFileOn * END FUNCTION GetOutputFileOn
* </PRE> * </PRE>
* </CODE> * </CODE>
@ -453,7 +465,7 @@ extern "C" {
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION GetSelectedOutputColumnCount * FUNCTION GetSelectedOutputColumnCount(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* INTEGER(KIND=4) :: GetSelectedOutputColumnCount * INTEGER(KIND=4) :: GetSelectedOutputColumnCount
* END FUNCTION GetSelectedOutputColumnCount * END FUNCTION GetSelectedOutputColumnCount
@ -473,7 +485,7 @@ extern "C" {
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION GetSelectedOutputFileOn(SELECTED_ON) * FUNCTION GetSelectedOutputFileOn(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* LOGICAL(KIND=4) :: GetSelectedOutputFileOn * LOGICAL(KIND=4) :: GetSelectedOutputFileOn
* END FUNCTION GetSelectedOutputFileOn * END FUNCTION GetSelectedOutputFileOn
@ -493,7 +505,7 @@ extern "C" {
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION GetSelectedOutputRowCount * FUNCTION GetSelectedOutputRowCount(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* INTEGER(KIND=4) :: GetSelectedOutputRowCount * INTEGER(KIND=4) :: GetSelectedOutputRowCount
* END FUNCTION GetSelectedOutputRowCount * END FUNCTION GetSelectedOutputRowCount
@ -715,7 +727,8 @@ Headings
* <PRE> * <PRE>
* SUBROUTINE GetWarningStringLine(ID,N,LINE) * SUBROUTINE GetWarningStringLine(ID,N,LINE)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* LOGICAL(KIND=4), INTENT(IN) :: DUMP_ON * LOGICAL(KIND=4), INTENT(IN) :: N
* CHARACTER(LEN=*), INTENT(OUT) :: LINE
* END SUBROUTINE GetWarningStringLine * END SUBROUTINE GetWarningStringLine
* </PRE> * </PRE>
* </CODE> * </CODE>
@ -758,7 +771,7 @@ Headings
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION LoadDatabase(FILENAME) * FUNCTION LoadDatabase(ID,FILENAME)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* CHARACTER(LEN=*), INTENT(IN) :: FILENAME * CHARACTER(LEN=*), INTENT(IN) :: FILENAME
* INTEGER(KIND=4) :: LoadDatabase * INTEGER(KIND=4) :: LoadDatabase
@ -788,7 +801,7 @@ Headings
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION LoadDatabaseString(INPUT) * FUNCTION LoadDatabaseString(ID,INPUT)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* CHARACTER(LEN=*), INTENT(IN) :: INPUT * CHARACTER(LEN=*), INTENT(IN) :: INPUT
* INTEGER(KIND=4) :: LoadDatabaseString * INTEGER(KIND=4) :: LoadDatabaseString
@ -808,7 +821,7 @@ Headings
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* SUBROUTINE OutputAccumulatedLines * SUBROUTINE OutputAccumulatedLines(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* END SUBROUTINE OutputAccumulatedLines * END SUBROUTINE OutputAccumulatedLines
* </PRE> * </PRE>
@ -829,7 +842,7 @@ Headings
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* SUBROUTINE OutputErrorString * SUBROUTINE OutputErrorString(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* END SUBROUTINE OutputErrorString * END SUBROUTINE OutputErrorString
* </PRE> * </PRE>
@ -853,7 +866,7 @@ Headings
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* SUBROUTINE OutputWarningString * SUBROUTINE OutputWarningString(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* END SUBROUTINE OutputWarningString * END SUBROUTINE OutputWarningString
* </PRE> * </PRE>
@ -875,7 +888,7 @@ Headings
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION RunAccumulated() * FUNCTION RunAccumulated(ID)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* INTEGER(KIND=4) :: RunAccumulated * INTEGER(KIND=4) :: RunAccumulated
* END FUNCTION RunAccumulated * END FUNCTION RunAccumulated
@ -900,9 +913,9 @@ Headings
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION RunFile(FILENAME) * FUNCTION RunFile(ID,FNAME)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* CHARACTER(LEN=*), INTENT(IN) :: FILENAME * CHARACTER(LEN=*), INTENT(IN) :: FNAME
* INTEGER(KIND=4) :: RunFile * INTEGER(KIND=4) :: RunFile
* END FUNCTION RunFile * END FUNCTION RunFile
* </PRE> * </PRE>
@ -929,7 +942,7 @@ Headings
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION RunString(INPUT) * FUNCTION RunString(ID,INPUT)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* CHARACTER(LEN=*), INTENT(IN) :: INPUT * CHARACTER(LEN=*), INTENT(IN) :: INPUT
* INTEGER(KIND=4) :: RunString * INTEGER(KIND=4) :: RunString
@ -961,6 +974,7 @@ Headings
* FUNCTION SetDumpFileOn(ID,DUMP_ON) * FUNCTION SetDumpFileOn(ID,DUMP_ON)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* LOGICAL(KIND=4), INTENT(IN) :: DUMP_ON * LOGICAL(KIND=4), INTENT(IN) :: DUMP_ON
* INTEGER(KIND=4) :: SetDumpFileOn
* END FUNCTION SetDumpFileOn * END FUNCTION SetDumpFileOn
* </PRE> * </PRE>
* </CODE> * </CODE>
@ -986,6 +1000,7 @@ Headings
* FUNCTION SetDumpStringOn(ID,DUMP_STRING_ON) * FUNCTION SetDumpStringOn(ID,DUMP_STRING_ON)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* LOGICAL(KIND=4), INTENT(IN) :: DUMP_STRING_ON * LOGICAL(KIND=4), INTENT(IN) :: DUMP_STRING_ON
* INTEGER(KIND=4) :: SetDumpStringOn
* END FUNCTION SetDumpStringOn * END FUNCTION SetDumpStringOn
* </PRE> * </PRE>
* </CODE> * </CODE>
@ -1013,9 +1028,10 @@ Headings
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION SetErrorFileOn(ERROR_ON) * FUNCTION SetErrorFileOn(ID,ERR_ON)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* LOGICAL(KIND=4), INTENT(IN) :: ERROR_ON * LOGICAL(KIND=4), INTENT(IN) :: ERR_ON
* INTEGER(KIND=4) :: SetErrorFileOn
* END FUNCTION SetErrorFileOn * END FUNCTION SetErrorFileOn
* </PRE> * </PRE>
* </CODE> * </CODE>
@ -1064,9 +1080,9 @@ Headings
* @htmlonly * @htmlonly
* <CODE> * <CODE>
* <PRE> * <PRE>
* FUNCTION SetOutputFileOn(ID,OUTPUT_ON) * FUNCTION SetOutputFileOn(ID,OUT_ON)
* INTEGER(KIND=4), INTENT(IN) :: ID * INTEGER(KIND=4), INTENT(IN) :: ID
* LOGICAL(KIND=4), INTENT(IN) :: OUTPUT_ON * LOGICAL(KIND=4), INTENT(IN) :: OUT_ON
* INTEGER(KIND=4) :: SetOutputFileOn * INTEGER(KIND=4) :: SetOutputFileOn
* END FUNCTION SetOutputFileOn * END FUNCTION SetOutputFileOn
* </PRE> * </PRE>

12
tests/test_f90.f90
View File

@ -22,6 +22,18 @@ FUNCTION F_MAIN()
RETURN RETURN
END IF END IF
IF (AccumulateLine(id, "SOLUTION 1").NE.IPQ_OK) THEN
CALL OutputErrorString(id)
F_MAIN = EXIT_FAILURE
RETURN
END IF
IF (ClearAccumulatedLines(id).NE.IPQ_OK) THEN
CALL OutputErrorString(id)
F_MAIN = EXIT_FAILURE
RETURN
END IF
! Dump ! Dump
IF (TestGetSet(id,GetDumpFileOn,SetDumpFileOn).NE.0) THEN IF (TestGetSet(id,GetDumpFileOn,SetDumpFileOn).NE.0) THEN
F_MAIN = EXIT_FAILURE F_MAIN = EXIT_FAILURE