From e80e834067272793658428cec4affb78c64aa15d Mon Sep 17 00:00:00 2001 From: Scott R Charlton Date: Thu, 27 May 2010 04:13:34 +0000 Subject: [PATCH] updated documentation git-svn-id: svn://136.177.114.72/svn_GW/IPhreeqc/trunk@4472 1feff8c3-07ed-0310-ac33-dd36852eb9cd --- include/IPhreeqc.f.inc | 5 +-- include/IPhreeqc.f90.inc | 54 ++++++++++++++++++-------------- include/IPhreeqc.h | 66 +++++++++++++++++++++++++--------------- tests/test_f90.f90 | 12 ++++++++ 4 files changed, 87 insertions(+), 50 deletions(-) diff --git a/include/IPhreeqc.f.inc b/include/IPhreeqc.f.inc index 291b6b76..eb12f9bf 100644 --- a/include/IPhreeqc.f.inc +++ b/include/IPhreeqc.f.inc @@ -45,16 +45,17 @@ C INTEGER(KIND=4) AccumulateLine INTEGER(KIND=4) AddError INTEGER(KIND=4) AddWarning + INTEGER(KIND=4) ClearAccumulatedLines INTEGER(KIND=4) CreateIPhreeqc INTEGER(KIND=4) DestroyIPhreeqc INTEGER(KIND=4) GetComponentCount + LOGICAL(KIND=4) GetDumpFileOn INTEGER(KIND=4) GetDumpStringLine INTEGER(KIND=4) GetDumpStringLineCount - LOGICAL(KIND=4) GetDumpFileOn LOGICAL(KIND=4) GetDumpStringOn + LOGICAL(KIND=4) GetErrorFileOn INTEGER(KIND=4) GetErrorStringLine INTEGER(KIND=4) GetErrorStringLineCount - LOGICAL(KIND=4) GetErrorFileOn LOGICAL(KIND=4) GetLogFileOn LOGICAL(KIND=4) GetOutputFileOn INTEGER(KIND=4) GetSelectedOutputColumnCount diff --git a/include/IPhreeqc.f90.inc b/include/IPhreeqc.f90.inc index 09b9fba2..0ea9c611 100644 --- a/include/IPhreeqc.f90.inc +++ b/include/IPhreeqc.f90.inc @@ -16,12 +16,12 @@ INTERFACE - FUNCTION AccumulateLine(ID, LINE) + FUNCTION AccumulateLine(ID,LINE) INTEGER(KIND=4), INTENT(IN) :: ID CHARACTER(LEN=*), INTENT(IN) :: LINE INTEGER(KIND=4) :: AccumulateLine END FUNCTION AccumulateLine - END INTERFACE + END INTERFACE INTERFACE @@ -30,7 +30,7 @@ CHARACTER(LEN=*), INTENT(IN) :: ERROR_MSG INTEGER(KIND=4) :: AddError END FUNCTION AddError - END INTERFACE + END INTERFACE INTERFACE @@ -39,7 +39,15 @@ CHARACTER(LEN=*), INTENT(IN) :: WARN_MSG INTEGER(KIND=4) :: AddWarning END FUNCTION AddWarning - END INTERFACE + END INTERFACE + + + INTERFACE + FUNCTION ClearAccumulatedLines(ID) + INTEGER(KIND=4), INTENT(IN) :: ID + INTEGER(KIND=4) :: ClearAccumulatedLines + END FUNCTION ClearAccumulatedLines + END INTERFACE INTERFACE @@ -74,6 +82,14 @@ END INTERFACE + INTERFACE + FUNCTION GetDumpFileOn(ID) + INTEGER(KIND=4), INTENT(IN) :: ID + LOGICAL(KIND=4) :: GetDumpFileOn + END FUNCTION GetDumpFileOn + END INTERFACE + + INTERFACE SUBROUTINE GetDumpStringLine(ID,N,LINE) INTEGER(KIND=4), INTENT(IN) :: ID @@ -89,16 +105,8 @@ INTEGER(KIND=4) :: GetDumpStringLineCount END FUNCTION GetDumpStringLineCount END INTERFACE - - - INTERFACE - FUNCTION GetDumpFileOn(ID) - INTEGER(KIND=4), INTENT(IN) :: ID - LOGICAL(KIND=4) :: GetDumpFileOn - END FUNCTION GetDumpFileOn - END INTERFACE - - + + INTERFACE FUNCTION GetDumpStringOn(ID) INTEGER(KIND=4), INTENT(IN) :: ID @@ -107,6 +115,14 @@ END INTERFACE + INTERFACE + FUNCTION GetErrorFileOn(ID) + INTEGER(KIND=4), INTENT(IN) :: ID + LOGICAL(KIND=4) :: GetErrorFileOn + END FUNCTION GetErrorFileOn + END INTERFACE + + INTERFACE SUBROUTINE GetErrorStringLine(ID,N,LINE) INTEGER(KIND=4), INTENT(IN) :: ID @@ -124,14 +140,6 @@ END INTERFACE - INTERFACE - FUNCTION GetErrorFileOn(ID) - INTEGER(KIND=4), INTENT(IN) :: ID - LOGICAL(KIND=4) :: GetErrorFileOn - END FUNCTION GetErrorFileOn - END INTERFACE - - INTERFACE FUNCTION GetLogFileOn(ID) INTEGER(KIND=4), INTENT(IN) :: ID @@ -224,7 +232,7 @@ SUBROUTINE OutputAccumulatedLines(ID) INTEGER(KIND=4), INTENT(IN) :: ID END SUBROUTINE OutputAccumulatedLines - END INTERFACE + END INTERFACE INTERFACE diff --git a/include/IPhreeqc.h b/include/IPhreeqc.h index bf8438dd..fd459e54 100644 --- a/include/IPhreeqc.h +++ b/include/IPhreeqc.h @@ -34,7 +34,7 @@ extern "C" { * @htmlonly * * 
- *  FUNCTION AccumulateLine(LINE)
+ *  FUNCTION AccumulateLine(ID,LINE)
  *    INTEGER(KIND=4),   INTENT(IN)  :: ID
  *    CHARACTER(LEN=*),  INTENT(IN)  :: LINE
  *    INTEGER(KIND=4)                :: AccumulateLine
@@ -104,6 +104,17 @@ extern "C" {
  *  @retval IPQ_OK           Success.
  *  @retval IPQ_BADINSTANCE  The given id is invalid.
  *  @see                     AccumulateLine, OutputAccumulatedLines, RunAccumulated
+ *  @par Fortran90 Interface:
+ *  @htmlonly
+ *  
+ *  
+ *  FUNCTION ClearAccumulatedLines(ID)
+ *    INTEGER(KIND=4), INTENT(IN) :: ID
+ *    INTEGER(KIND=4)             :: ClearAccumulatedLines
+ *  END FUNCTION ClearAccumulatedLines
+ *  

+ *  
+ *  @endhtmlonly
  */
 	IPQ_DLL_EXPORT IPQ_RESULT  ClearAccumulatedLines(int id);
 
@@ -229,10 +240,10 @@ extern "C" {
  *  @htmlonly
  *  
  *  
- *  FUNCTION GetDumpFileOn(DUMP_ON)
+ *  FUNCTION GetDumpFileOn(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *    LOGICAL(KIND=4)               :: GetDumpFileOn
- *  END FUNCTION SetDumpFileOn
+ *  END FUNCTION GetDumpFileOn
  *  

  *  
  *  @endhtmlonly
@@ -273,7 +284,7 @@ extern "C" {
  *    INTEGER(KIND=4),   INTENT(IN)   :: ID
  *    INTEGER(KIND=4),   INTENT(IN)   :: N
  *    CHARACTER(LEN=*),  INTENT(OUT)  :: LINE
- *  END SUBROUTINE GetComponent
+ *  END SUBROUTINE GetDumpStringLine
  *
* * @endhtmlonly @@ -318,7 +329,7 @@ extern "C" { * @htmlonly * * 
- *  FUNCTION GetDumpStringOn(DUMP_STRING_ON)
+ *  FUNCTION GetDumpStringOn(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *    LOGICAL(KIND=4)               :: GetDumpStringOn
  *  END FUNCTION GetDumpStringOn
@@ -338,7 +349,7 @@ extern "C" {
  *  @htmlonly
  *  
  *  
- *  FUNCTION GetErrorFileOn(ERROR_ON)
+ *  FUNCTION GetErrorFileOn(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *    LOGICAL(KIND=4)               :: GetErrorFileOn
  *  END FUNCTION GetErrorFileOn
@@ -371,7 +382,7 @@ extern "C" {
  *  @htmlonly
  *  
  *  
- *  SUBROUTINE GetErrorStringLine
+ *  SUBROUTINE GetErrorStringLine(ID,N,LINE)
  *    INTEGER(KIND=4),   INTENT(IN)   :: ID
  *    INTEGER(KIND=4),   INTENT(IN)   :: N
  *    CHARACTER(LEN=*),  INTENT(OUT)  :: LINE
@@ -392,7 +403,7 @@ extern "C" {
  *  @htmlonly
  *  
  *  
- *  FUNCTION GetErrorStringLineCount
+ *  FUNCTION GetErrorStringLineCount(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *    INTEGER(KIND=4)               :: GetErrorStringLineCount
  *  END FUNCTION GetErrorStringLineCount
@@ -436,6 +447,7 @@ extern "C" {
  *  
  *  FUNCTION GetOutputFileOn(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
+ *    LOGICAL(KIND=4)               :: GetOutputFileOn
  *  END FUNCTION GetOutputFileOn
  *  

  *  
@@ -453,7 +465,7 @@ extern "C" {
  *  @htmlonly
  *  
  *  
- *  FUNCTION GetSelectedOutputColumnCount
+ *  FUNCTION GetSelectedOutputColumnCount(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *    INTEGER(KIND=4)               :: GetSelectedOutputColumnCount
  *  END FUNCTION GetSelectedOutputColumnCount
@@ -473,7 +485,7 @@ extern "C" {
  *  @htmlonly
  *  
  *  
- *  FUNCTION GetSelectedOutputFileOn(SELECTED_ON)
+ *  FUNCTION GetSelectedOutputFileOn(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *    LOGICAL(KIND=4)               :: GetSelectedOutputFileOn
  *  END FUNCTION GetSelectedOutputFileOn
@@ -493,7 +505,7 @@ extern "C" {
  *  @htmlonly
  *  
  *  
- *  FUNCTION GetSelectedOutputRowCount
+ *  FUNCTION GetSelectedOutputRowCount(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *    INTEGER(KIND=4)               :: GetSelectedOutputRowCount
  *  END FUNCTION GetSelectedOutputRowCount
@@ -715,7 +727,8 @@ Headings
  *  
  *  SUBROUTINE GetWarningStringLine(ID,N,LINE)
  *    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
  *  

  *  
@@ -758,7 +771,7 @@ Headings
  *  @htmlonly
  *  
  *  
- *  FUNCTION LoadDatabase(FILENAME)
+ *  FUNCTION LoadDatabase(ID,FILENAME)
  *    INTEGER(KIND=4),   INTENT(IN)  :: ID
  *    CHARACTER(LEN=*),  INTENT(IN)  :: FILENAME
  *    INTEGER(KIND=4)                :: LoadDatabase
@@ -788,7 +801,7 @@ Headings
  *  @htmlonly
  *  
  *  
- *  FUNCTION LoadDatabaseString(INPUT)
+ *  FUNCTION LoadDatabaseString(ID,INPUT)
  *    INTEGER(KIND=4),   INTENT(IN)  :: ID
  *    CHARACTER(LEN=*),  INTENT(IN)  :: INPUT
  *    INTEGER(KIND=4)                :: LoadDatabaseString
@@ -808,7 +821,7 @@ Headings
  *  @htmlonly
  *  
  *  
- *  SUBROUTINE OutputAccumulatedLines
+ *  SUBROUTINE OutputAccumulatedLines(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *  END SUBROUTINE OutputAccumulatedLines
  *  

@@ -829,7 +842,7 @@ Headings
  *  @htmlonly
  *  
  *  
- *  SUBROUTINE OutputErrorString
+ *  SUBROUTINE OutputErrorString(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *  END SUBROUTINE OutputErrorString
  *  

@@ -853,7 +866,7 @@ Headings
  *  @htmlonly
  *  
  *  
- *  SUBROUTINE OutputWarningString
+ *  SUBROUTINE OutputWarningString(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *  END SUBROUTINE OutputWarningString
  *  

@@ -875,7 +888,7 @@ Headings
  *  @htmlonly
  *  
  *  
- *  FUNCTION RunAccumulated()
+ *  FUNCTION RunAccumulated(ID)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
  *    INTEGER(KIND=4)               :: RunAccumulated
  *  END FUNCTION RunAccumulated
@@ -900,9 +913,9 @@ Headings
  *  @htmlonly
  *  
  *  
- *  FUNCTION RunFile(FILENAME)
+ *  FUNCTION RunFile(ID,FNAME)
  *    INTEGER(KIND=4),   INTENT(IN)  :: ID
- *    CHARACTER(LEN=*),  INTENT(IN)  :: FILENAME
+ *    CHARACTER(LEN=*),  INTENT(IN)  :: FNAME
  *    INTEGER(KIND=4)                :: RunFile
  *  END FUNCTION RunFile
  *  

@@ -929,7 +942,7 @@ Headings
  *  @htmlonly
  *  
  *  
- *  FUNCTION RunString(INPUT)
+ *  FUNCTION RunString(ID,INPUT)
  *    INTEGER(KIND=4),  INTENT(IN)   :: ID
  *    CHARACTER(LEN=*),  INTENT(IN)  :: INPUT
  *    INTEGER(KIND=4)                :: RunString
@@ -961,6 +974,7 @@ Headings
  *  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
  *  

  *  
@@ -986,6 +1000,7 @@ Headings
  *  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
  *  

  *  
@@ -1013,9 +1028,10 @@ Headings
  *  @htmlonly
  *  
  *  
- *  FUNCTION SetErrorFileOn(ERROR_ON)
+ *  FUNCTION SetErrorFileOn(ID,ERR_ON)
  *    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
  *  

  *  
@@ -1064,9 +1080,9 @@ Headings
  *  @htmlonly
  *  
  *  
- *  FUNCTION SetOutputFileOn(ID,OUTPUT_ON)
+ *  FUNCTION SetOutputFileOn(ID,OUT_ON)
  *    INTEGER(KIND=4),  INTENT(IN)  :: ID
- *    LOGICAL(KIND=4),  INTENT(IN)  :: OUTPUT_ON
+ *    LOGICAL(KIND=4),  INTENT(IN)  :: OUT_ON
  *    INTEGER(KIND=4)               :: SetOutputFileOn
  *  END FUNCTION SetOutputFileOn
  *  

diff --git a/tests/test_f90.f90 b/tests/test_f90.f90
index f2b4fa4c..ecf9024f 100644
--- a/tests/test_f90.f90
+++ b/tests/test_f90.f90
@@ -22,6 +22,18 @@ FUNCTION F_MAIN()
      RETURN
   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
   IF (TestGetSet(id,GetDumpFileOn,SetDumpFileOn).NE.0) THEN
      F_MAIN = EXIT_FAILURE