iphreeqc Module Reference

IPHREEQC module from the PHREEQC project, needed to interact with PHREEQCRM. More...

Functions/Subroutines
integer function	accumulateline (id, line)
integer function	adderror (id, error_msg)
integer function	addwarning (id, warn_msg)
integer function	clearaccumulatedlines (id)
integer function	createiphreeqc ()
integer function	destroyiphreeqc (id)
integer function	getcomponentcount (id)
subroutine	getcomponent (id, n, comp)
integer function	getcurrentselectedoutputusernumber (id)
subroutine	getdumpfilename (id, fname)
logical function	getdumpfileon (id)
integer function	getdumpstringlinecount (id)
subroutine	getdumpstringline (id, n, line)
logical function	getdumpstringon (id)
subroutine	geterrorfilename (id, fname)
logical function	geterrorfileon (id)
logical function	geterroron (id)
integer function	geterrorstringlinecount (id)
subroutine	geterrorstringline (id, n, line)
logical function	geterrorstringon (id)
subroutine	getlogfilename (id, fname)
logical function	getlogfileon (id)
integer function	getlogstringlinecount (id)
subroutine	getlogstringline (id, n, line)
logical function	getlogstringon (id)
integer function	getnthselectedoutputusernumber (id, n)
subroutine	getoutputfilename (id, fname)
logical function	getoutputfileon (id)
integer function	getoutputstringlinecount (id)
subroutine	getoutputstringline (id, n, line)
logical function	getoutputstringon (id)
integer function	getselectedoutputcolumncount (id)
integer function	getselectedoutputcount (id)
subroutine	getselectedoutputfilename (id, fname)
logical function	getselectedoutputfileon (id)
integer function	getselectedoutputstringlinecount (id)
subroutine	getselectedoutputstringline (id, n, line)
logical function	getselectedoutputstringon (id)
integer function	getselectedoutputrowcount (id)
integer function	getselectedoutputvalue (id, row, col, vtype, dvalue, svalue, slength)
subroutine	getversionstring (version)
integer function	getwarningstringlinecount (id)
subroutine	getwarningstringline (id, n, line)
integer function	loaddatabase (id, filename)
integer function	loaddatabasestring (id, input)
subroutine	outputaccumulatedlines (id)
subroutine	outputerrorstring (id)
subroutine	outputwarningstring (id)
integer function	runaccumulated (id)
integer function	runfile (id, filename)
integer function	runstring (id, input)
integer function	setbasicfortrancallback (id, fcn)

Variables
integer(kind=4), parameter	tt_empty = 0
integer(kind=4), parameter	tt_error = 1
integer(kind=4), parameter	tt_double = 3
integer(kind=4), parameter	tt_string = 4
integer(kind=4), parameter	ipq_ok = 0
integer(kind=4), parameter	ipq_outofmemory = -1
integer(kind=4), parameter	ipq_badvartype = -2
integer(kind=4), parameter	ipq_invalidarg = -3
integer(kind=4), parameter	ipq_invalidrow = -4
integer(kind=4), parameter	ipq_invalidcol = -5
integer(kind=4), parameter	ipq_badinstance = -6

Detailed Description

IPHREEQC module from the PHREEQC project, needed to interact with PHREEQCRM.

Function/Subroutine Documentation

accumulateline()

integer function iphreeqc::accumulateline	(	integer, intent(in)	id,
		character(len=*), intent(in)	line
	)

adderror()

integer function iphreeqc::adderror	(	integer, intent(in)	id,
		character(len=*), intent(in)	error_msg
	)

addwarning()

integer function iphreeqc::addwarning	(	integer, intent(in)	id,
		character(len=*), intent(in)	warn_msg
	)

clearaccumulatedlines()

integer function iphreeqc::clearaccumulatedlines

(

integer, intent(in)

id

)

createiphreeqc()

integer function iphreeqc::createiphreeqc

destroyiphreeqc()

integer function iphreeqc::destroyiphreeqc

(

integer, intent(in)

id

)

getcomponent()

subroutine iphreeqc::getcomponent	(	integer, intent(in)	id,
		integer, intent(in)	n,
		character(len=*), intent(inout)	comp
	)

getcomponentcount()

integer function iphreeqc::getcomponentcount

(

integer, intent(in)

id

)

getcurrentselectedoutputusernumber()

integer function iphreeqc::getcurrentselectedoutputusernumber

(

integer, intent(in)

id

)

getdumpfilename()

subroutine iphreeqc::getdumpfilename	(	integer, intent(in)	id,
		character(len=*), intent(out)	fname
	)

getdumpfileon()

logical function iphreeqc::getdumpfileon

(

integer, intent(in)

id

)

getdumpstringline()

subroutine iphreeqc::getdumpstringline	(	integer, intent(in)	id,
		integer, intent(in)	n,
		character(len=*), intent(inout)	line
	)

getdumpstringlinecount()

integer function iphreeqc::getdumpstringlinecount

(

integer, intent(in)

id

)

getdumpstringon()

logical function iphreeqc::getdumpstringon

(

integer, intent(in)

id

)

geterrorfilename()

subroutine iphreeqc::geterrorfilename	(	integer, intent(in)	id,
		character(len=*), intent(inout)	fname
	)

geterrorfileon()

logical function iphreeqc::geterrorfileon

(

integer, intent(in)

id

)

geterroron()

logical function iphreeqc::geterroron

(

integer, intent(in)

id

)

geterrorstringline()

subroutine iphreeqc::geterrorstringline	(	integer, intent(in)	id,
		integer, intent(in)	n,
		character(len=*), intent(inout)	line
	)

geterrorstringlinecount()

integer function iphreeqc::geterrorstringlinecount

(

integer, intent(in)

id

)

geterrorstringon()

logical function iphreeqc::geterrorstringon

(

integer, intent(in)

id

)

getlogfilename()

subroutine iphreeqc::getlogfilename	(	integer, intent(in)	id,
		character(len=*), intent(inout)	fname
	)

getlogfileon()

logical function iphreeqc::getlogfileon

(

integer, intent(in)

id

)

getlogstringline()

subroutine iphreeqc::getlogstringline	(	integer, intent(in)	id,
		integer, intent(in)	n,
		character(len=*), intent(inout)	line
	)

getlogstringlinecount()

integer function iphreeqc::getlogstringlinecount

(

integer, intent(in)

id

)

getlogstringon()

logical function iphreeqc::getlogstringon

(

integer, intent(in)

id

)

getnthselectedoutputusernumber()

integer function iphreeqc::getnthselectedoutputusernumber	(	integer, intent(in)	id,
		integer, intent(in)	n
	)

getoutputfilename()

subroutine iphreeqc::getoutputfilename	(	integer, intent(in)	id,
		character(len=*), intent(out)	fname
	)

getoutputfileon()

logical function iphreeqc::getoutputfileon

(

integer, intent(in)

id

)

getoutputstringline()

subroutine iphreeqc::getoutputstringline	(	integer, intent(in)	id,
		integer, intent(in)	n,
		character(len=*), intent(inout)	line
	)

getoutputstringlinecount()

integer function iphreeqc::getoutputstringlinecount

(

integer, intent(in)

id

)

getoutputstringon()

logical function iphreeqc::getoutputstringon

(

integer, intent(in)

id

)

getselectedoutputcolumncount()

integer function iphreeqc::getselectedoutputcolumncount

(

integer, intent(in)

id

)

getselectedoutputcount()

integer function iphreeqc::getselectedoutputcount

(

integer, intent(in)

id

)

getselectedoutputfilename()

subroutine iphreeqc::getselectedoutputfilename	(	integer, intent(in)	id,
		character(len=*), intent(inout)	fname
	)

getselectedoutputfileon()

logical function iphreeqc::getselectedoutputfileon

(

integer, intent(in)

id

)

getselectedoutputrowcount()

integer function iphreeqc::getselectedoutputrowcount

(

integer, intent(in)

id

)

getselectedoutputstringline()

subroutine iphreeqc::getselectedoutputstringline	(	integer, intent(in)	id,
		integer, intent(in)	n,
		character(len=*), intent(inout)	line
	)

getselectedoutputstringlinecount()

integer function iphreeqc::getselectedoutputstringlinecount

(

integer, intent(in)

id

)

getselectedoutputstringon()

logical function iphreeqc::getselectedoutputstringon

(

integer, intent(in)

id

)

getselectedoutputvalue()

integer function iphreeqc::getselectedoutputvalue	(	integer, intent(in)	id,
		integer, intent(in)	row,
		integer, intent(in)	col,
		integer, intent(out)	vtype,
		double precision, intent(out)	dvalue,
		character(len=*), intent(out)	svalue,
		integer, intent(out), optional	slength
	)

getversionstring()

subroutine iphreeqc::getversionstring

(

character(len=*), intent(inout)

version

)

getwarningstringline()

subroutine iphreeqc::getwarningstringline	(	integer, intent(in)	id,
		integer, intent(in)	n,
		character(len=*), intent(inout)	line
	)

getwarningstringlinecount()

integer function iphreeqc::getwarningstringlinecount

(

integer, intent(in)

id

)

loaddatabase()

integer function iphreeqc::loaddatabase	(	integer, intent(in)	id,
		character(len=*), intent(in)	filename
	)

loaddatabasestring()

integer function iphreeqc::loaddatabasestring	(	integer, intent(in)	id,
		character(len=*), intent(in)	input
	)

outputaccumulatedlines()

subroutine iphreeqc::outputaccumulatedlines

(

integer, intent(in)

id

)

outputerrorstring()

subroutine iphreeqc::outputerrorstring

(

integer, intent(in)

id

)

outputwarningstring()

subroutine iphreeqc::outputwarningstring

(

integer, intent(in)

id

)

runaccumulated()

integer function iphreeqc::runaccumulated

(

integer, intent(in)

id

)

runfile()

integer function iphreeqc::runfile	(	integer, intent(in)	id,
		character(len=*), intent(in)	filename
	)

runstring()

integer function iphreeqc::runstring	(	integer, intent(in)	id,
		character(len=*), intent(in)	input
	)

Here is the call graph for this function:

setbasicfortrancallback()

integer function iphreeqc::setbasicfortrancallback	(		id,
			fcn
	)

Here is the caller graph for this function:

Variable Documentation

ipq_badinstance

integer(kind=4), parameter iphreeqc::ipq_badinstance = -6

ipq_badvartype

integer(kind=4), parameter iphreeqc::ipq_badvartype = -2

ipq_invalidarg

integer(kind=4), parameter iphreeqc::ipq_invalidarg = -3

ipq_invalidcol

integer(kind=4), parameter iphreeqc::ipq_invalidcol = -5

ipq_invalidrow

integer(kind=4), parameter iphreeqc::ipq_invalidrow = -4

ipq_ok

integer(kind=4), parameter iphreeqc::ipq_ok = 0

ipq_outofmemory

integer(kind=4), parameter iphreeqc::ipq_outofmemory = -1

tt_double

integer(kind=4), parameter iphreeqc::tt_double = 3

tt_empty

integer(kind=4), parameter iphreeqc::tt_empty = 0

tt_error

integer(kind=4), parameter iphreeqc::tt_error = 1

tt_string

integer(kind=4), parameter iphreeqc::tt_string = 4