Inheritance diagram for tspadvmodule::tspadvtype:

Collaboration diagram for tspadvmodule::tspadvtype:

Private Member Functions
procedure	adv_df

procedure	adv_ar

procedure	adv_dt

procedure	adv_fc

procedure	adv_cq

procedure	adv_da

procedure	allocate_scalars

procedure, private	read_options

procedure, private	advqtvd

procedure, private	advtvd_bd

procedure	adv_weight

procedure	advtvd

procedure	set_names

procedure	da

procedure	read_check_ionper

procedure	get_block_data

Private Attributes
integer(i4b), pointer	iadvwt => null()
	advection scheme (0 up, 1 central, 2 tvd) More...

real(dp), pointer	ats_percel => null()
	user-specified fractional number of cells advection can move a particle during one time step More...

integer(i4b), dimension(:), pointer, contiguous	ibound => null()
	pointer to model ibound More...

type(tspfmitype), pointer	fmi => null()
	pointer to fmi object More...

real(dp), pointer	eqnsclfac => null()
	governing equation scale factor; =1. for solute; =rhow*cpw for energy More...

character(len=lenmodelname)	name_model = ''
	the name of the model that contains this package More...

character(len=lenpackagename)	packname = ''
	name of the package More...

character(len=lenmempath)	memorypath = ''
	the location in the memory manager where the variables are stored More...

character(len=lenmempath)	memorypathmodel = ''
	the location in the memory manager where the variables of the parent model are stored More...

character(len=lenmempath)	input_mempath = ''
	input context mempath More...

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

character(len=lenftype)	filtyp = ''
	file type (CHD, DRN, RIV, etc.) More...

character(len=lenftype), pointer	package_type => null()
	package type (same as filtyp) stored in memory manager More...

integer(i4b), pointer	id => null()
	consecutive package number in model More...

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

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

integer(i4b), pointer	inewton => null()
	newton flag More...

integer(i4b), pointer	iasym => null()
	package causes matrix asymmetry More...

integer(i4b), pointer	iprpak => null()
	integer flag to echo input More...

integer(i4b), pointer	iprflow => null()
	flag to print simulated flows More...

integer(i4b), pointer	ipakcb => null()
	output flows (-1, 0, 1) - save_flows More...

integer(i4b), pointer	ionper => null()
	stress period for next data More...

integer(i4b), pointer	lastonper => null()
	last value of ionper (for checking) More...

type(blockparsertype)	parser
	parser object for reading blocks of information More...

class(disbasetype), pointer	dis => null()
	model discretization object More...

Detailed Description

Definition at line 17 of file tsp-adv.f90.

Member Function/Subroutine Documentation

◆ adv_ar()

procedure tspadvmodule::tspadvtype::adv_ar

private

Definition at line 28 of file tsp-adv.f90.

◆ adv_cq()

procedure tspadvmodule::tspadvtype::adv_cq

private

Definition at line 31 of file tsp-adv.f90.

◆ adv_da()

procedure tspadvmodule::tspadvtype::adv_da

private

Definition at line 32 of file tsp-adv.f90.

◆ adv_df()

procedure tspadvmodule::tspadvtype::adv_df

private

Definition at line 27 of file tsp-adv.f90.

◆ adv_dt()

procedure tspadvmodule::tspadvtype::adv_dt

private

Definition at line 29 of file tsp-adv.f90.

◆ adv_fc()

procedure tspadvmodule::tspadvtype::adv_fc

private

Definition at line 30 of file tsp-adv.f90.

◆ adv_weight()

procedure tspadvmodule::tspadvtype::adv_weight

private

Definition at line 38 of file tsp-adv.f90.

◆ advqtvd()

procedure, private tspadvmodule::tspadvtype::advqtvd

private

Definition at line 36 of file tsp-adv.f90.

◆ advtvd()

procedure tspadvmodule::tspadvtype::advtvd

private

Definition at line 39 of file tsp-adv.f90.

◆ advtvd_bd()

procedure, private tspadvmodule::tspadvtype::advtvd_bd

private

Definition at line 37 of file tsp-adv.f90.

◆ allocate_scalars()

procedure tspadvmodule::tspadvtype::allocate_scalars

private

Definition at line 34 of file tsp-adv.f90.

◆ da()

procedure numericalpackagemodule::numericalpackagetype::da

privateinherited

Definition at line 55 of file NumericalPackage.f90.

◆ get_block_data()

procedure numericalpackagemodule::numericalpackagetype::get_block_data

privateinherited

Definition at line 57 of file NumericalPackage.f90.

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper

privateinherited

Definition at line 56 of file NumericalPackage.f90.

◆ read_options()

procedure, private tspadvmodule::tspadvtype::read_options

private

Definition at line 35 of file tsp-adv.f90.

◆ set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names

privateinherited

Definition at line 53 of file NumericalPackage.f90.

Member Data Documentation

◆ ats_percel

real(dp), pointer tspadvmodule::tspadvtype::ats_percel => null()

private

Definition at line 20 of file tsp-adv.f90.

20 real(DP), pointer :: ats_percel => null() !< user-specified fractional number of cells advection can move a particle during one time step

◆ dis

class(disbasetype), pointer numericalpackagemodule::numericalpackagetype::dis => null()

privateinherited

Definition at line 50 of file NumericalPackage.f90.

50 class(DisBaseType), pointer :: dis => null() !< model discretization object

◆ eqnsclfac

real(dp), pointer tspadvmodule::tspadvtype::eqnsclfac => null()

private

Definition at line 23 of file tsp-adv.f90.

23 real(DP), pointer :: eqnsclfac => null() !< governing equation scale factor; =1. for solute; =rhow*cpw for energy

◆ filtyp

character(len=lenftype) numericalpackagemodule::numericalpackagetype::filtyp = ''

privateinherited

Definition at line 33 of file NumericalPackage.f90.

33 character(len=LENFTYPE) :: filtyp = '' !< file type (CHD, DRN, RIV, etc.)

◆ fmi

type(tspfmitype), pointer tspadvmodule::tspadvtype::fmi => null()

private

Definition at line 22 of file tsp-adv.f90.

22 type(TspFmiType), pointer :: fmi => null() !< pointer to fmi object

◆ iadvwt

integer(i4b), pointer tspadvmodule::tspadvtype::iadvwt => null()

private

Definition at line 19 of file tsp-adv.f90.

19 integer(I4B), pointer :: iadvwt => null() !< advection scheme (0 up, 1 central, 2 tvd)

◆ iasym

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iasym => null()

privateinherited

Definition at line 41 of file NumericalPackage.f90.

41 integer(I4B), pointer :: iasym => null() !< package causes matrix asymmetry

◆ ibound

integer(i4b), dimension(:), pointer, contiguous tspadvmodule::tspadvtype::ibound => null()

private

Definition at line 21 of file tsp-adv.f90.

21 integer(I4B), dimension(:), pointer, contiguous :: ibound => null() !< pointer to model ibound

◆ id

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::id => null()

privateinherited

Definition at line 37 of file NumericalPackage.f90.

37 integer(I4B), pointer :: id => null() !< consecutive package number in model

◆ inewton

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inewton => null()

privateinherited

Definition at line 40 of file NumericalPackage.f90.

40 integer(I4B), pointer :: inewton => null() !< newton flag

◆ input_fname

character(len=linelength), pointer numericalpackagemodule::numericalpackagetype::input_fname => null()

privateinherited

Definition at line 32 of file NumericalPackage.f90.

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

◆ input_mempath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::input_mempath = ''

privateinherited

Definition at line 31 of file NumericalPackage.f90.

31 character(len=LENMEMPATH) :: input_mempath = '' !< input context mempath

◆ inunit

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inunit => null()

privateinherited

Definition at line 38 of file NumericalPackage.f90.

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

◆ ionper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ionper => null()

privateinherited

Definition at line 45 of file NumericalPackage.f90.

45 integer(I4B), pointer :: ionper => null() !< stress period for next data

◆ iout

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iout => null()

privateinherited

Definition at line 39 of file NumericalPackage.f90.

39 integer(I4B), pointer :: iout => null() !< unit number for writing package output

◆ ipakcb

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ipakcb => null()

privateinherited

Definition at line 44 of file NumericalPackage.f90.

44 integer(I4B), pointer :: ipakcb => null() !< output flows (-1, 0, 1) - save_flows

◆ iprflow

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprflow => null()

privateinherited

Definition at line 43 of file NumericalPackage.f90.

43 integer(I4B), pointer :: iprflow => null() !< flag to print simulated flows

◆ iprpak

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprpak => null()

privateinherited

Definition at line 42 of file NumericalPackage.f90.

42 integer(I4B), pointer :: iprpak => null() !< integer flag to echo input

◆ lastonper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::lastonper => null()

privateinherited

Definition at line 46 of file NumericalPackage.f90.

46 integer(I4B), pointer :: lastonper => null() !< last value of ionper (for checking)

◆ memorypath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypath = ''

privateinherited

Definition at line 28 of file NumericalPackage.f90.

28 character(len=LENMEMPATH) :: memoryPath = '' !< the location in the memory manager where the variables are stored

◆ memorypathmodel

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypathmodel = ''

privateinherited

Definition at line 29 of file NumericalPackage.f90.

29 character(len=LENMEMPATH) :: memoryPathModel = '' !< the location in the memory manager where the variables

◆ name_model

character(len=lenmodelname) numericalpackagemodule::numericalpackagetype::name_model = ''

privateinherited

Definition at line 26 of file NumericalPackage.f90.

26 character(len=LENMODELNAME) :: name_model = '' !< the name of the model that contains this package

◆ package_type

character(len=lenftype), pointer numericalpackagemodule::numericalpackagetype::package_type => null()

privateinherited

Definition at line 34 of file NumericalPackage.f90.

34 character(len=LENFTYPE), pointer :: package_type => null() !< package type (same as filtyp) stored in memory manager

◆ packname

character(len=lenpackagename) numericalpackagemodule::numericalpackagetype::packname = ''

privateinherited

Definition at line 27 of file NumericalPackage.f90.

27 character(len=LENPACKAGENAME) :: packName = '' !< name of the package

◆ parser

type(blockparsertype) numericalpackagemodule::numericalpackagetype::parser

privateinherited

Definition at line 49 of file NumericalPackage.f90.

49 type(BlockParserType) :: parser !< parser object for reading blocks of information

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

/home/runner/work/modflow6/modflow6/src/Model/TransportModel/tsp-adv.f90

Private Member Functions

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ adv_ar()

◆ adv_cq()

◆ adv_da()

◆ adv_df()

◆ adv_dt()

◆ adv_fc()

◆ adv_weight()

◆ advqtvd()

◆ advtvd()

◆ advtvd_bd()

◆ allocate_scalars()

◆ da()

◆ get_block_data()

◆ read_check_ionper()

◆ read_options()

◆ set_names()

Member Data Documentation

◆ ats_percel

◆ dis

◆ eqnsclfac

◆ filtyp

◆ fmi

◆ iadvwt

◆ iasym

◆ ibound

◆ id

◆ inewton

◆ input_fname

◆ input_mempath

◆ inunit

◆ ionper

◆ iout

◆ ipakcb

◆ iprflow

◆ iprpak

◆ lastonper

◆ memorypath

◆ memorypathmodel

◆ name_model

◆ package_type

◆ packname

◆ parser