@ brief Output control for particle tracking models More...

Inheritance diagram for prtocmodule::prtoctype:

Collaboration diagram for prtocmodule::prtoctype:

Private Member Functions
procedure	oc_ar

procedure	oc_da => prt_oc_da

procedure	allocate_scalars => prt_oc_allocate_scalars

procedure	source_options => prt_oc_source_options

procedure, private	prt_oc_source_dimensions

procedure, private	prt_oc_source_tracktimes

procedure	oc_df

procedure	oc_rp

procedure	oc_ot

procedure	set_ocfile

procedure	oc_save

procedure	oc_print

procedure	oc_save_unit

procedure	set_print_flag

Private Attributes
integer(i4b), pointer	itrkout => null()
	binary output file More...

integer(i4b), pointer	itrkhdr => null()
	output header file More...

integer(i4b), pointer	itrkcsv => null()
	CSV output file. More...

integer(i4b), pointer	itrktls => null()
	track time list input file More...

logical(lgp), pointer	trackrelease => null()
	whether to track release events More...

logical(lgp), pointer	trackfeatexit => null()
	whether to track grid-scale feature exit events More...

logical(lgp), pointer	tracktimestep => null()
	whether to track timestep events More...

logical(lgp), pointer	trackterminate => null()
	whether to track termination events More...

logical(lgp), pointer	trackweaksink => null()
	whether to track weak sink exit events More...

logical(lgp), pointer	trackusertime => null()
	whether to track user-specified times More...

logical(lgp), pointer	tracksubfexit => null()
	whether to track sub-grid-scale feature exit events More...

logical(lgp), pointer	trackdropped => null()
	whether to track drops to water table More...

integer(i4b), pointer	ntracktimes => null()
	number of user-specified tracking times More...

logical(lgp), pointer	dump_event_trace => null()
	whether to dump event trace for debugging More...

logical(lgp), pointer	scratch_buffer => null()
	whether to use scratch file instead of memory for event buffering More...

type(timeselecttype), pointer	tracktimes
	user-specified tracking times More...

character(len=lenmempath)	memorypath
	path to data stored in the memory manager More...

character(len=lenmempath)	input_mempath
	input memory path More...

character(len=lenmodelname), pointer	name_model => null()
	name of the model More...

character(len=linelength), pointer	input_fname => null()
	input file name More...

integer(i4b), pointer	inunit => null()
	unit number for input file More...

integer(i4b), pointer	iout => null()
	unit number for output file More...

integer(i4b), pointer	ibudcsv => null()
	unit number for budget csv output file More...

integer(i4b), pointer	iperoc => null()
	stress period number for next output control More...

integer(i4b), pointer	iocrep => null()
	output control repeat flag (period 0 step 0) More...

type(outputcontroldatatype), dimension(:), pointer, contiguous	ocds => null()
	output control objects More...

Detailed Description

Definition at line 21 of file prt-oc.f90.

Member Function/Subroutine Documentation

◆ allocate_scalars()

procedure prtocmodule::prtoctype::allocate_scalars

private

Definition at line 42 of file prt-oc.f90.

◆ oc_ar()

procedure prtocmodule::prtoctype::oc_ar

private

Definition at line 40 of file prt-oc.f90.

◆ oc_da()

procedure prtocmodule::prtoctype::oc_da

private

Definition at line 41 of file prt-oc.f90.

◆ oc_df()

procedure outputcontrolmodule::outputcontroltype::oc_df

privateinherited

Definition at line 27 of file OutputControl.f90.

◆ oc_ot()

procedure outputcontrolmodule::outputcontroltype::oc_ot

privateinherited

Definition at line 29 of file OutputControl.f90.

◆ oc_print()

procedure outputcontrolmodule::outputcontroltype::oc_print

privateinherited

Definition at line 35 of file OutputControl.f90.

◆ oc_rp()

procedure outputcontrolmodule::outputcontroltype::oc_rp

privateinherited

Definition at line 28 of file OutputControl.f90.

◆ oc_save()

procedure outputcontrolmodule::outputcontroltype::oc_save

privateinherited

Definition at line 34 of file OutputControl.f90.

◆ oc_save_unit()

procedure outputcontrolmodule::outputcontroltype::oc_save_unit

privateinherited

Definition at line 36 of file OutputControl.f90.

◆ prt_oc_source_dimensions()

procedure, private prtocmodule::prtoctype::prt_oc_source_dimensions

private

Definition at line 44 of file prt-oc.f90.

◆ prt_oc_source_tracktimes()

procedure, private prtocmodule::prtoctype::prt_oc_source_tracktimes

private

Definition at line 45 of file prt-oc.f90.

◆ set_ocfile()

procedure outputcontrolmodule::outputcontroltype::set_ocfile

privateinherited

Definition at line 33 of file OutputControl.f90.

◆ set_print_flag()

procedure outputcontrolmodule::outputcontroltype::set_print_flag

privateinherited

Definition at line 37 of file OutputControl.f90.

◆ source_options()

procedure prtocmodule::prtoctype::source_options

private

Definition at line 43 of file prt-oc.f90.

Member Data Documentation

◆ dump_event_trace

logical(lgp), pointer prtocmodule::prtoctype::dump_event_trace => null()

private

Definition at line 35 of file prt-oc.f90.

35 logical(LGP), pointer :: dump_event_trace => null() !< whether to dump event trace for debugging

◆ ibudcsv

integer(i4b), pointer outputcontrolmodule::outputcontroltype::ibudcsv => null()

privateinherited

Definition at line 22 of file OutputControl.f90.

22 integer(I4B), pointer :: ibudcsv => null() !< unit number for budget csv output file

◆ input_fname

character(len=linelength), pointer outputcontrolmodule::outputcontroltype::input_fname => null()

privateinherited

Definition at line 19 of file OutputControl.f90.

19 character(len=LINELENGTH), pointer :: input_fname => null() !< input file name

◆ input_mempath

character(len=lenmempath) outputcontrolmodule::outputcontroltype::input_mempath

privateinherited

Definition at line 17 of file OutputControl.f90.

17 character(len=LENMEMPATH) :: input_mempath !< input memory path

◆ inunit

integer(i4b), pointer outputcontrolmodule::outputcontroltype::inunit => null()

privateinherited

Definition at line 20 of file OutputControl.f90.

20 integer(I4B), pointer :: inunit => null() !< unit number for input file

◆ iocrep

integer(i4b), pointer outputcontrolmodule::outputcontroltype::iocrep => null()

privateinherited

Definition at line 24 of file OutputControl.f90.

24 integer(I4B), pointer :: iocrep => null() !< output control repeat flag (period 0 step 0)

◆ iout

integer(i4b), pointer outputcontrolmodule::outputcontroltype::iout => null()

privateinherited

Definition at line 21 of file OutputControl.f90.

21 integer(I4B), pointer :: iout => null() !< unit number for output file

◆ iperoc

integer(i4b), pointer outputcontrolmodule::outputcontroltype::iperoc => null()

privateinherited

Definition at line 23 of file OutputControl.f90.

23 integer(I4B), pointer :: iperoc => null() !< stress period number for next output control

◆ itrkcsv

integer(i4b), pointer prtocmodule::prtoctype::itrkcsv => null()

private

Definition at line 24 of file prt-oc.f90.

24 integer(I4B), pointer :: itrkcsv => null() !< CSV output file

◆ itrkhdr

integer(i4b), pointer prtocmodule::prtoctype::itrkhdr => null()

private

Definition at line 23 of file prt-oc.f90.

23 integer(I4B), pointer :: itrkhdr => null() !< output header file

◆ itrkout

integer(i4b), pointer prtocmodule::prtoctype::itrkout => null()

private

Definition at line 22 of file prt-oc.f90.

22 integer(I4B), pointer :: itrkout => null() !< binary output file

◆ itrktls

integer(i4b), pointer prtocmodule::prtoctype::itrktls => null()

private

Definition at line 25 of file prt-oc.f90.

25 integer(I4B), pointer :: itrktls => null() !< track time list input file

◆ memorypath

character(len=lenmempath) outputcontrolmodule::outputcontroltype::memorypath

privateinherited

Definition at line 16 of file OutputControl.f90.

16 character(len=LENMEMPATH) :: memoryPath !< path to data stored in the memory manager

◆ name_model

character(len=lenmodelname), pointer outputcontrolmodule::outputcontroltype::name_model => null()

privateinherited

Definition at line 18 of file OutputControl.f90.

18 character(len=LENMODELNAME), pointer :: name_model => null() !< name of the model

◆ ntracktimes

integer(i4b), pointer prtocmodule::prtoctype::ntracktimes => null()

private

Definition at line 34 of file prt-oc.f90.

34 integer(I4B), pointer :: ntracktimes => null() !< number of user-specified tracking times

◆ ocds

type(outputcontroldatatype), dimension(:), pointer, contiguous outputcontrolmodule::outputcontroltype::ocds => null()

privateinherited

Definition at line 25 of file OutputControl.f90.

25 type(OutputControlDataType), pointer, contiguous :: ocds(:) => null() !< output control objects

◆ scratch_buffer

logical(lgp), pointer prtocmodule::prtoctype::scratch_buffer => null()

private

Definition at line 36 of file prt-oc.f90.

36 logical(LGP), pointer :: scratch_buffer => null() !< whether to use scratch file instead of memory for event buffering

◆ trackdropped

logical(lgp), pointer prtocmodule::prtoctype::trackdropped => null()

private

Definition at line 33 of file prt-oc.f90.

33 logical(LGP), pointer :: trackdropped => null() !< whether to track drops to water table

◆ trackfeatexit

logical(lgp), pointer prtocmodule::prtoctype::trackfeatexit => null()

private

Definition at line 27 of file prt-oc.f90.

27 logical(LGP), pointer :: trackfeatexit => null() !< whether to track grid-scale feature exit events

◆ trackrelease

logical(lgp), pointer prtocmodule::prtoctype::trackrelease => null()

private

Definition at line 26 of file prt-oc.f90.

26 logical(LGP), pointer :: trackrelease => null() !< whether to track release events

◆ tracksubfexit

logical(lgp), pointer prtocmodule::prtoctype::tracksubfexit => null()

private

Definition at line 32 of file prt-oc.f90.

32 logical(LGP), pointer :: tracksubfexit => null() !< whether to track sub-grid-scale feature exit events

◆ trackterminate

logical(lgp), pointer prtocmodule::prtoctype::trackterminate => null()

private

Definition at line 29 of file prt-oc.f90.

29 logical(LGP), pointer :: trackterminate => null() !< whether to track termination events

◆ tracktimes

type(timeselecttype), pointer prtocmodule::prtoctype::tracktimes

private

Definition at line 37 of file prt-oc.f90.

37 type(TimeSelectType), pointer :: tracktimes !< user-specified tracking times

◆ tracktimestep

logical(lgp), pointer prtocmodule::prtoctype::tracktimestep => null()

private

Definition at line 28 of file prt-oc.f90.

28 logical(LGP), pointer :: tracktimestep => null() !< whether to track timestep events

◆ trackusertime

logical(lgp), pointer prtocmodule::prtoctype::trackusertime => null()

private

Definition at line 31 of file prt-oc.f90.

31 logical(LGP), pointer :: trackusertime => null() !< whether to track user-specified times

◆ trackweaksink

logical(lgp), pointer prtocmodule::prtoctype::trackweaksink => null()

private

Definition at line 30 of file prt-oc.f90.

30 logical(LGP), pointer :: trackweaksink => null() !< whether to track weak sink exit events

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

/home/runner/work/modflow6/modflow6/src/Model/ParticleTracking/prt-oc.f90

Private Member Functions

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ allocate_scalars()

◆ oc_ar()

◆ oc_da()

◆ oc_df()

◆ oc_ot()

◆ oc_print()

◆ oc_rp()

◆ oc_save()

◆ oc_save_unit()

◆ prt_oc_source_dimensions()

◆ prt_oc_source_tracktimes()

◆ set_ocfile()

◆ set_print_flag()

◆ source_options()

Member Data Documentation

◆ dump_event_trace

◆ ibudcsv

◆ input_fname

◆ input_mempath

◆ inunit

◆ iocrep

◆ iout

◆ iperoc

◆ itrkcsv

◆ itrkhdr

◆ itrkout

◆ itrktls

◆ memorypath

◆ name_model

◆ ntracktimes

◆ ocds

◆ scratch_buffer

◆ trackdropped

◆ trackfeatexit

◆ trackrelease

◆ tracksubfexit

◆ trackterminate

◆ tracktimes

◆ tracktimestep

◆ trackusertime

◆ trackweaksink