timeoutputs::tdout Type Reference

Data structure containing values of a variable possibly depending on time (e.g., forcing function). More...

Public Member Functions
procedure, pass, public	init (this, stderr, dimdata, ndata)
	Static constructor for timeoutputs::tdout.
procedure, pass, public	kill (this, lun)
	Static destructor for timeoutputs::tdout.
procedure, pass, public	info (this, lun, nsample)
	Info procedure for timeoutputs::tdout.
procedure, pass, public	write2dat (this, lun)
	Writing procedure for timeoutputs::tdout.
procedure, pass, public	write_end_time (this, lun)
	Write variable ::time.
procedure, pass, public	eval_ninput (this)
	Compute number of data arrays (columns of tdout::tdactual) having non-zero norm.

Public Attributes
logical	built
	Logical flag to check if object is initialized.
integer	dimdata
	Dimension of real data array.
integer	ndata
	Number of data arrays.
real(kind=double), dimension(:, :), allocatable	tdactual
	Dimension (::dimdata,::ndata).
real(kind=double)	time
	Time associated to data stored in ::tdactual.
logical	steadytd
	.true. if data doeas not depend on time .false. if data depends on time
logical	steadytd_written = .false.
	.true. if steady state data has already been written .false. otherwise

Detailed Description

Data structure containing values of a variable possibly depending on time (e.g., forcing function).

This data structure can be used, for example, for storing the values of a forcing function. Each colum of tdout::tdactual represent the value of the forcing function in a different point of the domain. All the values are associated to a specific time value.

Definition at line 16 of file modTimeOutputs.f90.

Member Function/Subroutine Documentation

init()

procedure, pass, public timeoutputs::tdout::init	(	class(tdout), intent(out)	this,
		integer, intent(in)	stderr,
		integer, intent(in)	dimdata,
		integer, intent(in)	ndata )

Static constructor for timeoutputs::tdout.

---

Initialize variables tdout::dimdata and tdout::ndata and allocate variable tdout::tdactual. Set tdout::built = .true. and tdout::steadytd = .false.

Parameters

[in]	stderr	unit number for error message
[in]	dimdata	value to be assigned to tdout::dimdata
[in]	ndata	value to be assigned to tdout::ndata

Definition at line 35 of file modTimeOutputs.f90.

kill()

procedure, pass, public timeoutputs::tdout::kill	(	class(tdout), intent(inout)	this,
		integer, intent(in)	lun )

Static destructor for timeoutputs::tdout.

---

Deallocate array tdout::tdactual and set tdout::built = .false.

Parameters

[in]

lun

unit number for error message

Definition at line 37 of file modTimeOutputs.f90.

info()

procedure, pass, public timeoutputs::tdout::info	(	class(tdout), intent(in)	this,
		integer, intent(in)	lun,
		integer, intent(in)	nsample )

Info procedure for timeoutputs::tdout.

---

Write non-zero content of variable tdout::tdactual

Parameters

[in]	lun	unit number for output message
[in]	nsample	number of first non zero columns of tdout::tdactual to print

Definition at line 39 of file modTimeOutputs.f90.

write2dat()

procedure, pass, public timeoutputs::tdout::write2dat	(	class(tdout), intent(inout)	this,
		integer, intent(in)	lun )

Writing procedure for timeoutputs::tdout.

---

If tdout::steadytd_written = .false. this procedure writes the columns of tdout::tdactual having non-zero norm, otherwise it does nothin. Then, if tdout::steadytd = .true. set tdout::steadytd_written = .true..

Parameters

[in]

lun

unit number for output

Definition at line 41 of file modTimeOutputs.f90.

write_end_time()

procedure, pass, public timeoutputs::tdout::write_end_time	(	class(tdout), intent(inout)	this,
		integer, intent(in)	lun )

Write variable ::time.

---

Parameters

[in]

lun

unit number for output message

Definition at line 43 of file modTimeOutputs.f90.

eval_ninput()

procedure, pass, public timeoutputs::tdout::eval_ninput

(

class(tdout), intent(in)

this

)

Compute number of data arrays (columns of tdout::tdactual) having non-zero norm.

---

Returns

(integer) number of data arrays (columns of tdout::tdactual) having non-zero norm

Definition at line 46 of file modTimeOutputs.f90.

Member Data Documentation

built

logical timeoutputs::tdout::built

Logical flag to check if object is initialized.

Definition at line 18 of file modTimeOutputs.f90.

dimdata

integer timeoutputs::tdout::dimdata

Dimension of real data array.

Definition at line 20 of file modTimeOutputs.f90.

ndata

integer timeoutputs::tdout::ndata

Number of data arrays.

Definition at line 22 of file modTimeOutputs.f90.

tdactual

real(kind=double), dimension(:, :), allocatable timeoutputs::tdout::tdactual

Dimension (::dimdata,::ndata).

Definition at line 24 of file modTimeOutputs.f90.

time

real(kind=double) timeoutputs::tdout::time

Time associated to data stored in ::tdactual.

Definition at line 26 of file modTimeOutputs.f90.

steadytd

logical timeoutputs::tdout::steadytd

.true. if data doeas not depend on time .false. if data depends on time

Definition at line 29 of file modTimeOutputs.f90.

steadytd_written

logical timeoutputs::tdout::steadytd_written = .false.

.true. if steady state data has already been written .false. otherwise

Definition at line 32 of file modTimeOutputs.f90.

---

The documentation for this type was generated from the following file:

• /home/runner/work/globals/globals/srcs/modTimeOutputs.f90