Derived type for the SSM Package. More...

Inheritance diagram for tspssmmodule::tspssmtype:

Collaboration diagram for tspssmmodule::tspssmtype:

Public Member Functions
procedure	ssm_df

procedure	ssm_ar

procedure	ssm_rp

procedure	ssm_ad

procedure	ssm_fc

procedure	ssm_cq

procedure	ssm_bd

procedure	ssm_ot_flow

procedure	ssm_da

procedure	allocate_scalars

Public Attributes
integer(i4b), pointer	nbound
	total number of flow boundaries in this time step More...

integer(i4b), dimension(:), pointer, contiguous	isrctype => null()
	source type 0 is unspecified, 1 is aux, 2 is auxmixed, 3 is ssmi, 4 is ssmimixed More...

integer(i4b), dimension(:), pointer, contiguous	iauxpak => null()
	aux col for concentration More...

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

real(dp), dimension(:), pointer, contiguous	cnew => null()
	pointer to gwtx More...

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

type(tabletype), pointer	outputtab => null()
	output table object More...

type(gwtspctype), dimension(:), pointer	ssmivec => null()
	array of stress package concentration objects More...

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

character(len=lenvarname)	depvartype = ''

Private Member Functions
procedure, private	ssm_term

procedure, private	allocate_arrays

procedure, private	read_options

procedure, private	read_data

procedure, private	read_sources_aux

procedure, private	read_sources_fileinput

procedure, private	pak_setup_outputtab

procedure, private	set_iauxpak

procedure, private	set_ssmivec

procedure, private	get_ssm_conc

procedure	set_names

procedure	da

procedure	read_check_ionper

procedure	get_block_data

Private Attributes
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

This derived type corresponds to the SSM Package, which adds the effects of groundwater sources and sinks to the solute transport equation.

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

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure, private tspssmmodule::tspssmtype::allocate_arrays

private

Definition at line 63 of file tsp-ssm.f90.

◆ allocate_scalars()

procedure tspssmmodule::tspssmtype::allocate_scalars

Definition at line 61 of file tsp-ssm.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.

◆ get_ssm_conc()

procedure, private tspssmmodule::tspssmtype::get_ssm_conc

private

Definition at line 71 of file tsp-ssm.f90.

◆ pak_setup_outputtab()

procedure, private tspssmmodule::tspssmtype::pak_setup_outputtab

private

Definition at line 68 of file tsp-ssm.f90.

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper

privateinherited

Definition at line 56 of file NumericalPackage.f90.

◆ read_data()

procedure, private tspssmmodule::tspssmtype::read_data

private

Definition at line 65 of file tsp-ssm.f90.

◆ read_options()

procedure, private tspssmmodule::tspssmtype::read_options

private

Definition at line 64 of file tsp-ssm.f90.

◆ read_sources_aux()

procedure, private tspssmmodule::tspssmtype::read_sources_aux

private

Definition at line 66 of file tsp-ssm.f90.

◆ read_sources_fileinput()

procedure, private tspssmmodule::tspssmtype::read_sources_fileinput

private

Definition at line 67 of file tsp-ssm.f90.

◆ set_iauxpak()

procedure, private tspssmmodule::tspssmtype::set_iauxpak

private

Definition at line 69 of file tsp-ssm.f90.

◆ set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names

privateinherited

Definition at line 53 of file NumericalPackage.f90.

◆ set_ssmivec()

procedure, private tspssmmodule::tspssmtype::set_ssmivec

private

Definition at line 70 of file tsp-ssm.f90.

◆ ssm_ad()

procedure tspssmmodule::tspssmtype::ssm_ad

Definition at line 55 of file tsp-ssm.f90.

◆ ssm_ar()

procedure tspssmmodule::tspssmtype::ssm_ar

Definition at line 53 of file tsp-ssm.f90.

◆ ssm_bd()

procedure tspssmmodule::tspssmtype::ssm_bd

Definition at line 58 of file tsp-ssm.f90.

◆ ssm_cq()

procedure tspssmmodule::tspssmtype::ssm_cq

Definition at line 57 of file tsp-ssm.f90.

◆ ssm_da()

procedure tspssmmodule::tspssmtype::ssm_da

Definition at line 60 of file tsp-ssm.f90.

◆ ssm_df()

procedure tspssmmodule::tspssmtype::ssm_df

Definition at line 52 of file tsp-ssm.f90.

◆ ssm_fc()

procedure tspssmmodule::tspssmtype::ssm_fc

Definition at line 56 of file tsp-ssm.f90.

◆ ssm_ot_flow()

procedure tspssmmodule::tspssmtype::ssm_ot_flow

Definition at line 59 of file tsp-ssm.f90.

◆ ssm_rp()

procedure tspssmmodule::tspssmtype::ssm_rp

Definition at line 54 of file tsp-ssm.f90.

◆ ssm_term()

procedure, private tspssmmodule::tspssmtype::ssm_term

private

Definition at line 62 of file tsp-ssm.f90.

Member Data Documentation

◆ cnew

real(dp), dimension(:), pointer, contiguous tspssmmodule::tspssmtype::cnew => null()

Definition at line 43 of file tsp-ssm.f90.

43 real(DP), dimension(:), pointer, contiguous :: cnew => null() !< pointer to gwt%x

◆ depvartype

character(len=lenvarname) tspssmmodule::tspssmtype::depvartype = ''

Definition at line 48 of file tsp-ssm.f90.

48 character(len=LENVARNAME) :: depvartype = ''

◆ 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 tspssmmodule::tspssmtype::eqnsclfac => null()

Definition at line 47 of file tsp-ssm.f90.

47 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 tspssmmodule::tspssmtype::fmi => null()

Definition at line 44 of file tsp-ssm.f90.

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

◆ 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

◆ iauxpak

integer(i4b), dimension(:), pointer, contiguous tspssmmodule::tspssmtype::iauxpak => null()

Definition at line 41 of file tsp-ssm.f90.

41 integer(I4B), dimension(:), pointer, contiguous :: iauxpak => null() !< aux col for concentration

◆ ibound

integer(i4b), dimension(:), pointer, contiguous tspssmmodule::tspssmtype::ibound => null()

Definition at line 42 of file tsp-ssm.f90.

42 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

◆ isrctype

integer(i4b), dimension(:), pointer, contiguous tspssmmodule::tspssmtype::isrctype => null()

Definition at line 40 of file tsp-ssm.f90.

40 integer(I4B), dimension(:), pointer, contiguous :: isrctype => null() !< source type 0 is unspecified, 1 is aux, 2 is auxmixed, 3 is ssmi, 4 is ssmimixed

◆ 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

◆ nbound

integer(i4b), pointer tspssmmodule::tspssmtype::nbound

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

39 integer(I4B), pointer :: nbound !< total number of flow boundaries in this time step

◆ outputtab

type(tabletype), pointer tspssmmodule::tspssmtype::outputtab => null()

Definition at line 45 of file tsp-ssm.f90.

45 type(TableType), pointer :: outputtab => null() !< output table object

◆ 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

◆ ssmivec

type(gwtspctype), dimension(:), pointer tspssmmodule::tspssmtype::ssmivec => null()

Definition at line 46 of file tsp-ssm.f90.

46 type(GwtSpcType), dimension(:), pointer :: ssmivec => null() !< array of stress package concentration objects

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

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ allocate_arrays()

◆ allocate_scalars()

◆ da()

◆ get_block_data()

◆ get_ssm_conc()

◆ pak_setup_outputtab()

◆ read_check_ionper()

◆ read_data()

◆ read_options()

◆ read_sources_aux()

◆ read_sources_fileinput()

◆ set_iauxpak()

◆ set_names()

◆ set_ssmivec()

◆ ssm_ad()

◆ ssm_ar()

◆ ssm_bd()

◆ ssm_cq()

◆ ssm_da()

◆ ssm_df()

◆ ssm_fc()

◆ ssm_ot_flow()

◆ ssm_rp()

◆ ssm_term()

Member Data Documentation

◆ cnew

◆ depvartype

◆ dis

◆ eqnsclfac

◆ filtyp

◆ fmi

◆ iasym

◆ iauxpak

◆ ibound

◆ id

◆ inewton

◆ input_fname

◆ input_mempath

◆ inunit

◆ ionper

◆ iout

◆ ipakcb

◆ iprflow

◆ iprpak

◆ isrctype

◆ lastonper

◆ memorypath

◆ memorypathmodel

◆ name_model

◆ nbound

◆ outputtab

◆ package_type

◆ packname

◆ parser

◆ ssmivec