def __init__(self, model, nsfinit=0, mxsfbc=0, icbcsf=0, ioutobs=0,
ietsfr=0, isfsolv=0, wimp=0.50, wups=1.00, cclosesf=1.0E-6,
mxitersf=10, crntsf=1.0, coldsf=0.0, dispsf=0.0, nobssf=0,
obs_sf=None, sf_stress_period_data = None, dtype=None,
extension='sft',unitnumber=None, **kwargs):
#unit number
if unitnumber is None:
unitnumber = self.unitnumber
Package.__init__(self, model, extension, 'SFT', self.unitnumber)
# Set dimensions
nrow = model.nrow
ncol = model.ncol
nlay = model.nlay
ncomp = model.ncomp
mcomp = model.mcomp
# Set package specific parameters
self.nsfinit = nsfinit
self.mxsfbc = mxsfbc
self.icbcsf = icbcsf
self.ioutobs = ioutobs
self.ietsfr = ietsfr
self.isfsolv = isfsolv
self.wimp = wimp
self.wups = wups
self.cclosesf = cclosesf
self.mxitersf = mxitersf
self.crntsf = crntsf
# Set 1D array values
self.coldsf = Util2d(model, (nsfinit,), np.float32, coldsf,
name='coldsf', locat=self.unit_number[0])
self.dispsf = Util2d(model, (nsfinit,), np.float32, dispsf,
name='dispsf', locat=self.unit_number[0])
# Set streamflow observation locations
self.nobssf = nobssf
self.obs_sf = obs_sf
# Read and set transient data
if dtype is not None:
self.dtype = dtype
else:
self.dtype = self.get_default_dtype(ncomp)
if sf_stress_period_data is None:
self.sf_stress_period_data = None
else:
self.sf_stress_period_data = MfList(self, model=model,
data=sf_stress_period_data)
self.parent.add_package(self)
return
def __init__(self, model, iwelcb=None, stress_period_data=None):
unitnumber = 2
filenames = [None]
name = [Modflow88Wel.ftype()]
units = [unitnumber]
extra = [""]
fname = [filenames[0]]
extension = "wel"
super(Modflow88Wel, self).__init__(model, extension=extension,
name=name, unit_number=units, extra=extra,
filenames=fname)
self.dtype = self.get_default_dtype()
self.stress_period_data = MfList(self, stress_period_data)
self.parent.add_package(self)
def __init__(self, model, nlkinit=0, mxlkbc=0, icbclk=0, ietlak=0,
coldlak=0.0, lk_stress_period_data=None, dtype=None,
extension='lkt', unitnumber=None, **kwargs):
#unit number
if unitnumber is None:
unitnumber = self.unitnumber
Package.__init__(self, model, extension, 'LKT', self.unitnumber)
# Set dimensions
nrow = model.nrow
ncol = model.ncol
nlay = model.nlay
ncomp = model.ncomp
# Set package specific parameters
self.nlkinit = nlkinit
self.mxlkbc = mxlkbc
self.icbclk = icbclk
self.ietlak = ietlak
# Set initial lake concentrations
if coldlak is not None:
self.coldlak = Util2d(self.parent, (nlkinit,), np.float32, coldlak,
name='coldlak', locat=self.unit_number[0])
else:
self.coldlak = Util2d(self.parent, (nlkinit,), np.float32, 0.0,
name='coldlak', locat=self.unit_number[0])
# Set transient data
if dtype is not None:
self.dtype = dtype
else:
self.dtype = self.get_default_dtype(ncomp)
if lk_stress_period_data is None:
self.lk_stress_period_data = None
else:
self.lk_stress_period_data = MfList(self, model=model,
data=lk_stress_period_data)
self.parent.add_package(self)
return
class Mt3dLkt(Package):
"""
MT3D-USGS LaKe Transport package class
Parameters
----------
model : model object
The model object (of type :class:`flopy.mt3dms.mt.Mt3dms`) to which
this package will be added.
nlkinit : int
is equal to the number of simulated lakes as specified in the flow
simulation
mxlkbc : int
must be greater than or equal to the sum total of boundary conditions
applied to each lake
icbclk : int
is equal to the unit number on which lake-by-lake transport information
will be printed. This unit number must appear in the NAM input file
required for every MT3D-USGS simulation.
ietlak : int
specifies whether or not evaporation as simulated in the flow solution
will act as a mass sink.
= 0, Mass does not exit the model via simulated lake evaporation
!= 0, Mass may leave the lake via simulated lake evaporation
coldlak : array of floats
is a vector of real numbers representing the initial concentrations in
the simulated lakes. The length of the vector is equal to the number
of simulated lakes, NLKINIT. Initial lake concentrations should be
in the same order as the lakes appearing in the LAK input file
corresponding to the MODFLOW simulation.
ntmp : int
is an integer value corresponding to the number of specified lake
boundary conditions to follow. For the first stress period, this
value must be greater than or equal to zero, but may be less than
zero in subsequent stress periods.
ilkbc : int
is the lake number for which the current boundary condition will be
specified
ilkbctyp : int
specifies what the boundary condition type is for ilakbc
1 a precipitation boundary. If precipitation directly to lakes
is simulated in the flow model and a non-zero concentration
(default is zero) is desired, use ISFBCTYP = 1;
2 a runoff boundary condition that is not the same thing as
runoff simulated in the UZF1 package and routed to a lake (or
stream) using the IRNBND array. Users who specify runoff in
the LAK input via the RNF variable appearing in record set 9a
and want to assign a non-zero concentration (default is zero)
associated with this specified source, use ISFBCTYP=2;
3 a Pump boundary condition. Users who specify a withdrawl
from a lake via the WTHDRW variable appearing in record set 9a
and want to assign a non-zero concentration (default is zero)
associated with this specified source, use ISFBCTYP=2;
4 an evaporation boundary condition. In models where evaporation
is simulated directly from the surface of the lake, users can use
this boundary condition to specify a non-zero concentration
(default is zero) associated with the evaporation losses.
Attributes
----------
Methods
-------
See Also
--------
Notes
-----
Parameters are not supported in FloPy.
Examples
--------
>>> import flopy
>>> mt = flopy.mt3d.Mt3dms()
>>> lkt = flopy.mt3d.Mt3dLkt(mt)
"""
unitnumber = 45
def __init__(self, model, nlkinit=0, mxlkbc=0, icbclk=0, ietlak=0,
coldlak=0.0, lk_stress_period_data=None, dtype=None,
extension='lkt', unitnumber=None, **kwargs):
#unit number
if unitnumber is None:
unitnumber = self.unitnumber
Package.__init__(self, model, extension, 'LKT', self.unitnumber)
# Set dimensions
nrow = model.nrow
ncol = model.ncol
nlay = model.nlay
ncomp = model.ncomp
# Set package specific parameters
self.nlkinit = nlkinit
self.mxlkbc = mxlkbc
self.icbclk = icbclk
self.ietlak = ietlak
# Set initial lake concentrations
if coldlak is not None:
self.coldlak = Util2d(self.parent, (nlkinit,), np.float32, coldlak,
name='coldlak', locat=self.unit_number[0])
else:
self.coldlak = Util2d(self.parent, (nlkinit,), np.float32, 0.0,
name='coldlak', locat=self.unit_number[0])
# Set transient data
if dtype is not None:
self.dtype = dtype
else:
self.dtype = self.get_default_dtype(ncomp)
if lk_stress_period_data is None:
self.lk_stress_period_data = None
else:
self.lk_stress_period_data = MfList(self, model=model,
data=lk_stress_period_data)
self.parent.add_package(self)
return
def write_file(self):
"""
Write the package file
Returns
-------
None
"""
# Open file for writing
f_lkt = open(self.fn_path, 'w')
# Item 1
f_lkt.write('{0:10d}{1:10d}{2:10}{3:10} '
.format(self.nlkinit, self.mxlkbc, self.icbclk, self.ietlak) +
'# NLKINIT, MXLKBC, ICBCLK, IETLAK\n')
# Item 2
f_lkt.write(self.coldlak.get_file_entry())
# Items 3-4
# (Loop through each stress period and write LKT information)
nper = self.parent.nper
for kper in range(nper):
if f_lkt.closed == True:
f_lkt = open(f_lkt.name, 'a')
# List of concentrations associated with fluxes in/out of lake
# (Evap, precip, specified runoff into the lake, specified
# withdrawl directly from the lake
if self.lk_stress_period_data is not None:
self.lk_stress_period_data.write_transient(f_lkt, single_per=kper)
else:
f_lkt.write('{}\n'.format(0))
f_lkt.close()
return
@staticmethod
def load(f, model, nlak=None, nper=None, ncomp=None, ext_unit_dict=None):
"""
Load an existing package.
Parameters
----------
f : filename or file handle
File to load.
model : model object
The model object (of type :class:`flopy.mt3d.mt.Mt3dms`) to
which this package will be added.
nlak : int
number of lakes to be simulated
nper : int
number of stress periods
ncomp : int
number of species to be simulated
ext_unit_dict : dictionary, optional
If the arrays in the file are specified using EXTERNAL,
or older style array control records, then `f` should be a file
handle. In this case ext_unit_dict is required, which can be
constructed using the function
:class:`flopy.utils.mfreadnam.parsenamefile`.
Returns
-------
lkt : MT3D-USGS object
MT3D-USGS object.
Examples
--------
>>> import flopy
>>> import os
>>> os.chdir(r'C:\EDM_LT\GitHub\mt3d-usgs\autotest\temp\LKT')
>>> mt = flopy.mt3d.Mt3dms.load('lkt_mt.nam', exe_name = 'mt3d-usgs_1.0.00.exe',
>>> model_ws = r'.\LKT',
>>> load_only='btn')
>>> lkt = flopy.mt3d.Mt3dLkt.load('test.lkt', mt)
"""
if model.verbose:
sys.stdout.write('loading lkt package file...\n')
if not hasattr(f, 'read'):
filename = f
f = open(filename, 'r')
# Set default nlay values
nlay = None
nrow = None
ncol = None
# Set dimensions if necessary
if nlay is None:
nlay = model.nlay
if nrow is None:
nrow = model.nrow
if ncol is None:
ncol = model.ncol
if nper is None:
nper = model.nper
if ncomp is None:
ncomp = model.ncomp
# Item 1 (NLKINIT,MXLKBC,ICBCLK,IETLAK)
line = f.readline()
if line[0] == '#':
if model.verbose:
print(' LKT package currently does not support comment lines...')
sys.exit()
if model.verbose:
print(' loading nlkinit,mxlkbc,icbclk,ietlak ')
vals = line.strip().split()
nlkinit = int(vals[0])
mxlkbc = int(vals[1])
icbclk = int(vals[2])
ietlak = int(vals[3])
if model.verbose:
print(' NLKINIT {}'.format(nlkinit))
print(' MXLKBC {}'.format(mxlkbc))
print(' ICBCLK {}'.format(icbclk))
print(' IETLAK {}'.format(ietlak))
if ietlak == 0:
print(' Mass does not exit the model via simulated lake evaporation ')
else:
print(' Mass exits the lake via simulated lake evaporation ')
# Item 2 (COLDLAK - Initial concentration in this instance)
if model.verbose:
print(' loading initial concentration ')
if model.array_foramt == 'free':
# ******************************
# Need to fill this section out
# ******************************
pass
else:
# Read header line
line = f.readline()
# Next, read the values
coldlak = np.empty((nlkinit), dtype=np.float)
coldlak = read1d(f, coldlak)
# dtype
dtype = Mt3dLkt.get_default_dtype(ncomp)
# Items 3-4
lk_stress_period_data = {}
for iper in range(nper):
if model.verbose:
print(' loading lkt boundary condition data for kper {0:5d}'
.format(iper + 1))
# Item 3: NTMP: An integer value corresponding to the number of
# specified lake boundary conditions to follow.
# For the first stress period, this value must be greater
# than or equal to zero, but may be less than zero in
# subsequent stress periods.
line = f.readline()
vals = line.strip().split()
ntmp = int(vals[0])
if model.verbose:
print(" {0:5d}".format(ntmp) + " lkt boundary conditions specified ")
if (iper == 0) and (ntmp < 0):
print(' ntmp < 0 not allowed for first stress period ')
if (iper > 0) and (ntmp < 0):
print(' use lkt boundary conditions specified in last stress period ')
# Item 4: Read ntmp boundary conditions
if ntmp > 0:
current_lk = np.empty((ntmp), dtype=dtype)
for ilkbnd in range(ntmp):
line = f.readline()
m_arr = line.strip().split() # These items are free format
t = []
for ivar in range(2):
t.append(m_arr[ivar])
cbclk = len(current_sf.dtype.names) - 2
if cbcsf > 0:
for ilkvar in range(cbclk):
t.append(m_arr[ilkvar + 3])
current_lk[ilkbnd] = tuple(t[:len(current_lk.dtype.names)])
# Convert ILKBC index to zero-based
current_lk['ILKBC'] -= 1
current_lk = current_lk.view(np.recarray)
lk_stress_period_data[iper] = current_lk
else:
if model.verbose:
print(' No transient boundary conditions specified')
pass
if len(lk_stress_period_data) == 0:
lk_stress_period_data = None
# Construct and return LKT package
lkt = Mt3dLkt(model, nlkinit=nlkinit, mxlkbc=mxlkbc, icbclk=icbclk,
ietlak=ietlak, coldlak=coldlak,
lk_stress_period_data=lk_stress_period_data)
return lkt
@staticmethod
def get_default_dtype(ncomp=1):
"""
Construct a dtype for the recarray containing the list of boundary
conditions interacting with the lake (i.e., pumps, specified runoff...)
"""
type_list = [("ILKBC", np.int), ("ILKBCTYPE", np.int), ("CBCLK", np.float32)]
if ncomp > 1:
for comp in range(1,ncomp+1):
comp_name = "clkt({0:02d})".format(comp)
type_list.append((comp_name, np.float32))
dtype = np.dtype(type_list)
return dtype
class Mt3dSft(Package):
"""
MT3D-USGS StreamFlow Transport package class
Parameters
----------
model : model object
The model object (of type :class:`flopy.mt3dms.mt.Mt3dms`) to which
this package will be added.
nsfinit : int
Is the number of simulated stream reaches (in SFR2, the number of
stream reaches is greater than or equal to the number of stream
segments). This is equal to NSTRM found on the first line of the
SFR2 input file. If NSFINIT > 0 then surface-water transport is
solved in the stream network while taking into account groundwater
exchange and precipitation and evaporation sources and sinks.
Otherwise, if NSFINIT < 0, the surface-water network as represented
by the SFR2 flow package merely acts as a boundary condition to the
groundwater transport problem; transport in the surface-water
network is not simulated.
mxsfbc : int
Is the maximum number of stream boundary conditions.
icbcsf : int
Is an integer value that directs MT3D-USGS to write reach-by-reach
concentration information to unit ICBCSF.
ioutobs : int
Is the unit number of the output file for simulated concentrations at
specified gage locations. The NAM file must also list the unit
number to which observation information will be written.
ietsfr : int
Specifies whether or not mass will exit the surface-water network
with simulated evaporation. If IETSFR = 0, then mass does not leave
via stream evaporation. If IETSFR > 0, then mass is allowed to exit
the simulation with the simulated evaporation.
isfsolv : int
Specifies the numerical technique that will be used to solve the
transport problem in the surface water network. The first release
of MT3D-USGS (version 1.0) only allows for a finite-difference
formulation and regardless of what value the user specifies, the
variable defaults to 1, meaning the finite-difference solution is
invoked.
wimp : float
Is the stream solver time weighting factor. Ranges between 0.0 and
1.0. Values of 0.0, 0.5, or 1.0 correspond to explicit,
Crank-Nicolson, and fully implicit schemes, respectively.
wups : float
Is the space weighting factor employed in the stream network solver.
Ranges between 0.0 and 1.0. Values of 0.0 and 1.0 correspond to a
central-in-space and upstream weighting factors, respectively.
cclosesf : float
Is the closure criterion for the SFT solver
mxitersf : int
Limits the maximum number of iterations the SFT solver can use to
find a solution of the stream transport problem.
crntsf : float
Is the Courant constraint specific to the SFT time step, its value
has no bearing upon the groundwater transport solution time step.
coldsf : array of floats
Represents the initial concentrations in the surface water network.
The length of the array is equal to the number of stream reaches and
starting concentration values should be entered in the same order
that individual reaches are entered for record set 2 in the SFR2
input file.
dispsf : array of floats
Is the dispersion coefficient [L2 T-1] for each stream reach in the
simulation and can vary for each simulated component of the
simulation. That is, the length of the array is equal to the number
of simulated stream reaches times the number of simulated components.
Values of dispersion for each reach should be entered in the same
order that individual reaches are entered for record set 2 in the
SFR2 input file. The first NSTRM entries correspond to NCOMP = 1,
with subsequent entries for each NCOMP simulated species.
nobssf : int
Specifies the number of surface flow observation points for
monitoring simulated concentrations in streams.
isobs : int
The segment number for each stream flow concentration observation
point.
irobs : int
The reach number for each stream flow concentration observation point.
ntmp : int
The number of specified stream boundary conditions to follow. For
the first stress period, this value must be greater than or equal to
zero, but may be less than zero in subsequent stress periods.
isegbc : int
Is the segment number for which the current boundary condition will
be applied.
irchbc : int
Is the reach number for which the current boundary condition will be
applied.
isfbctyp : int
Specifies, for ISEGBC/IRCHBC, what the boundary condition type is
0 A headwater boundary. That is, for streams entering at the
boundary of the simulated domain that need a specified
concentration, use ISFBCTYP = 0
1 a precipitation boundary. If precipitation directly to
channels is simulated in the flow model and a non-zero
concentration (default is zero) is desired, use ISFBCTYP = 1
2 a runoff boundary condition that is not the same thing as
runoff simulated in the UZF1 package and routed to a stream
(or lake) using the IRNBND array. Users who specify runoff
in the SFR2 input via the RUNOFF variable appearing in either
record sets 4b or 6a and want to assign a non-zero
concentration (default is zero) associated with this specified
source, use ISFBCTYP=2;
3 a constant-concentration boundary. Any ISEGBC/IRCHBC
combination may set equal to a constant concentration boundary
condition.
4 a pumping boundary condition.
5 an evaporation boundary condition. In models where
evaporation is simulated directly from the surface of the
channel, users can use this boundary condition to specify a
non-zero concentration (default is zero) associated with the
evaporation losses.
cbcsf : float
Is the specified concentration associated with the current boundary
condition entry. Repeat CBCSF for each simulated species (NCOMP).
Attributes
----------
Methods
-------
See Also
--------
Notes
-----
Parameters are not supported in FloPy.
Examples
--------
>>> mf = flopy.modflow.Modflow.load('CrnkNic_mf.nam',
>>> load_only=['dis', 'bas6'])
>>> sfr = flopy.modflow.ModflowSfr2.load('CrnkNic.sfr2', mf)
>>> chk = sfr.check()
>>> # initialize an MT3D-USGS model
>>> mt = flopy.mt3d.Mt3dms.load('CrnkNic_mt.nam',
>>> exe_name = 'mt3d-usgs_1.0.00.exe',
>>> model_ws = r'.\CrnkNic',
>>> load_only='btn')
>>> sft = flopy.mt3d.Mt3dSft.load('CrnkNic.sft', mt)
"""
unitnumber = 46
def __init__(self, model, nsfinit=0, mxsfbc=0, icbcsf=0, ioutobs=0,
ietsfr=0, isfsolv=0, wimp=0.50, wups=1.00, cclosesf=1.0E-6,
mxitersf=10, crntsf=1.0, coldsf=0.0, dispsf=0.0, nobssf=0,
obs_sf=None, sf_stress_period_data = None, dtype=None,
extension='sft',unitnumber=None, **kwargs):
#unit number
if unitnumber is None:
unitnumber = self.unitnumber
Package.__init__(self, model, extension, 'SFT', self.unitnumber)
# Set dimensions
nrow = model.nrow
ncol = model.ncol
nlay = model.nlay
ncomp = model.ncomp
mcomp = model.mcomp
# Set package specific parameters
self.nsfinit = nsfinit
self.mxsfbc = mxsfbc
self.icbcsf = icbcsf
self.ioutobs = ioutobs
self.ietsfr = ietsfr
self.isfsolv = isfsolv
self.wimp = wimp
self.wups = wups
self.cclosesf = cclosesf
self.mxitersf = mxitersf
self.crntsf = crntsf
# Set 1D array values
self.coldsf = Util2d(model, (nsfinit,), np.float32, coldsf,
name='coldsf', locat=self.unit_number[0])
self.dispsf = Util2d(model, (nsfinit,), np.float32, dispsf,
name='dispsf', locat=self.unit_number[0])
# Set streamflow observation locations
self.nobssf = nobssf
self.obs_sf = obs_sf
# Read and set transient data
if dtype is not None:
self.dtype = dtype
else:
self.dtype = self.get_default_dtype(ncomp)
if sf_stress_period_data is None:
self.sf_stress_period_data = None
else:
self.sf_stress_period_data = MfList(self, model=model,
data=sf_stress_period_data)
self.parent.add_package(self)
return
@staticmethod
def get_default_dtype(ncomp=1):
"""
Construct a dtype for the recarray containing the list of surface
water boundary conditions.
"""
type_list = [("isegbc", np.int), ("irchbc", np.int), \
("isfbctyp", np.int)]
if ncomp > 1:
for comp in range(1,ncomp+1):
comp_name = "cbcsf{0:d}".format(comp)
type_list.append((comp_name, np.float32))
dtype = np.dtype(type_list)
return dtype
def write_file(self):
"""
Write the package file
Returns
-------
None
Examples
--------
>>> mt = flopy.mt3d.Mt3dms.load('CrnkNic_mt.nam',
>>> exe_name = 'mt3d-usgs_1.0.00.exe',
>>> model_ws = r'C:\EDM_LT\GitHub\mt3d-usgs\autotest\temp\CrnkNic',
>>> verbose=True)
>>> mt.name = 'CrnkNic_rewrite'
>>>
>>> mt.sft.dispsf.fmtin = '(10F12.2)'
>>> mt.write_input()
"""
# Open file for writing
f_sft = open(self.fn_path, 'w')
# Item 1
f_sft.write('{0:10d}{1:10d}{2:10d}{3:10d}{4:10d}'.format(self.nsfinit,
self.mxsfbc, self.icbcsf, self.ioutobs, self.ietsfr) +
' # nsfinit, mxsfbc, icbcsf, ioutobs, ietsfr\n')
# Item 2
f_sft.write('{0:10d}{1:10.5f}{2:10.5f}{3:10.5f}{4:10d}{5:10.5f}'
.format(self.isfsolv, self.wimp, self.wups, self.cclosesf,
self.mxsfbc, self.crntsf) +
' # isfsolv, wimp, wups, cclosesf, mxitersf, crntsf\n')
# Item 3
f_sft.write(self.coldsf.get_file_entry())
# Item 4
f_sft.write(self.dispsf.get_file_entry())
# Item 5
f_sft.write('{0:10d} # nobssf\n'.format(self.nobssf))
# Item 6
if self.nobssf != 0:
for iobs in range(self.nobssf):
f_sft.write('{0:10d}{1:10d} # isobs, irobs\n'
.format(self.obs_sf[iobs][0], self.obs_sf[iobs][1]))
# Items 7, 8
# Loop through each stress period and write ssm information
nper = self.parent.nper
for kper in range(nper):
if f_sft.closed == True:
f_sft = open(f_sft.name, 'a')
# List of concentrations associated with various boundaries
# interacting with the stream network.
if self.sf_stress_period_data is not None:
self.sf_stress_period_data.write_transient(f_sft,
single_per=kper)
else:
f_sft.write('{0:10d} # ntmp - SP {1:5d}'.format(0, kper))
f_sft.close()
return
@staticmethod
def load(f, model, nsfinit=None, nper=None, ncomp=None, ext_unit_dict=None):
"""
Load an existing package.
Parameters
----------
f : filename or file handle
File to load.
model : model object
The model object (of type :class:`flopy.mt3d.mt.Mt3dms`) to
which this package will be added.
nsfinit : int
number of simulated stream reaches in the surface-water transport
process.
isfsolv : int
Specifies the numerical technique that will be used to solve the
transport problem in the surface water network. The first release
of MT3D-USGS (version 1.0) only allows for a finite-difference
formulation and regardless of what value the user specifies, the
variable defaults to 1, meaning the finite-difference solution is
invoked.
wimp : float
Is the stream solver time weighting factor. Ranges between 0.0 and
1.0. Values of 0.0, 0.5, or 1.0 correspond to explicit,
Crank-Nicolson, and fully implicit schemes, respectively.
wups : float
Is the space weighting factor employed in the stream network solver.
Ranges between 0.0 and 1.0. Values of 0.0 and 1.0 correspond to a
central-in-space and upstream weighting factors, respectively.
cclosesf : float
Is the closure criterion for the SFT solver
mxitersf : int
Limits the maximum number of iterations the SFT solver can use to
find a solution of the stream transport problem.
crntsf : float
Is the Courant constraint specific to the SFT time step, its value
has no bearing upon the groundwater transport solution time step.
Returns
-------
sft : MT3D-USGS object
MT3D-USGS object
Examples
--------
>>> import os
>>> import flopy
>>> os.chdir(r'C:\EDM_LT\GitHub\mt3d-usgs\autotest\temp\CrnkNic')
>>> mf = flopy.modflow.Modflow.load('CrnkNic_mf.nam', load_only=['dis', 'bas6'])
>>> sfr = flopy.modflow.ModflowSfr2.load('CrnkNic.sfr2', mf)
>>> chk = sfr.check()
"""
if model.verbose:
sys.stdout.write('loading sft package file...\n')
if not hasattr(f, 'read'):
filename = f
f = open(filename, 'r')
# Set default nlay values
nlay = None
nrow = None
ncol = None
# Set dimensions if necessary
if nlay is None:
nlay = model.nlay
if nrow is None:
nrow = model.nrow
if ncol is None:
ncol = model.ncol
if nper is None:
nper = model.nper
if ncomp is None:
ncomp = model.ncomp
dtype = Mt3dSft.get_default_dtype(ncomp)
# Item 1 (NSFINIT, MXSFBC, ICBCSF, IOUTOBS, IETSFR)
line = f.readline()
if line[0] == '#':
if model.verbose:
print(' SFT package currently does not support comment lines...')
sys.exit()
if model.verbose:
print(' loading nsfinit, mxsfbc, icbcsf, ioutobs, ietsfr...')
vals = line.strip().split()
nsfinit = int(vals[0])
mxsfbc = int(vals[1])
icbcsf = int(vals[2])
ioutobs = int(vals[3])
ietsfr = int(vals[4])
if model.verbose:
print(' NSFINIT {}'.format(nsfinit))
print(' MXSFBC {}'.format(mxsfbc))
print(' ICBCSF {}'.format(icbcsf))
print(' IOUTOBS {}'.format(ioutobs))
print(' IETSFR {}'.format(ietsfr))
if ietsfr == 0:
print(' Mass does not exit the model via simulated stream evaporation ')
else:
print(' Mass exits the stream network via simulated stream evaporation ')
# Item 2 (ISFSOLV, WIMP, WUPS, CCLOSESF, MXITERSF, CRNTSF)
line = f.readline()
if model.verbose:
print(' loading isfsolv, wimp, wups, cclosesf, mxitersf, crntsf...')
vals = line.strip().split()
if len(vals) < 6 and model.verbose:
print(' not enough values specified in item 2 of SFT input \
file, exiting...')
sys.exit()
else:
isfsolv = int(vals[0])
wimp = float(vals[1])
wups = float(vals[2])
cclosesf = float(vals[3])
mxitersf = int(vals[4])
crntsf = float(vals[5])
if isfsolv != 1:
isfsolv = 1
print(' Resetting isfsolv to 1')
print(' In version 1.0 of MT3D-USGS, isfsov=1 is only option')
if model.verbose:
print(' ISFSOLV {}'.format(isfsolv))
print(' WIMP {}'.format(wimp))
print(' WUPS {}'.format(wups))
print(' CCLOSESF {}'.format(cclosesf))
print(' MXITERSF {}'.format(mxitersf))
print(' CRNTSF {}'.format(crntsf))
# Item 3 (COLDSF(NRCH)) Initial concentration
if model.verbose:
print(' loading NSFINIT...')
if model.free_format:
print(' Using MODFLOW style array reader utilities to read \
NSFINIT')
elif model.array_format == None:
print(' Using historic MT3DMS array reader utilities to \
read NSFINIT')
# Because SFT package is a new package, it only accepts free format
# Don't need to worry about reading fixed format here
coldsf = Util2d.load(f, model, (1, nsfinit), np.float32, 'nsfinit',
ext_unit_dict)
# Item 4 (DISPSF(NRCH)) Reach-by-reach dispersion
if model.verbose:
if model.free_format:
print(' Using MODFLOW style array reader utilities to read \
DISPSF')
elif model.free_format is None:
print(' Using historic MT3DMS array reader utilities to \
read DISPSF')
# Because SFT package is a new package, it only accepts free format.
# Don't need to worry about reading fixed format here
dispsf = Util2d.load(f, model, (1, nsfinit), np.float32, 'dispsf',
ext_unit_dict)
# Item 5 NOBSSF
if model.verbose:
print(' loading NOBSSF...')
line = f.readline()
m_arr = line.strip().split()
nobssf = int(m_arr[0])
if model.verbose:
print(' NOBSSF {}'.format(nobssf))
# If NOBSSF > 0, store observation segment & reach (Item 6)
obs_sf = []
if nobssf > 0:
if model.verbose:
print(' loading {} observation locations given by ISOBS, '\
'IROBS...'.format(nobssf))
for i in range(nobssf):
line = f.readline()
m_arr = line.strip().split()
obs_sf.append([int(m_arr[0]), int(m_arr[1])])
obs_sf = np.array(obs_sf)
if model.verbose:
print(' Surface water concentration observation locations:')
print(' {}',format(obs_sf))
else:
if model.verbose:
print(' No observation points specified.')
sf_stress_period_data = {}
for iper in range(nper):
# Item 7 NTMP (Transient data)
if model.verbose:
print(' loading NTMP...')
line = f.readline()
m_arr = line.strip().split()
ntmp = int(m_arr[0])
# Item 8 ISEGBC, IRCHBC, ISFBCTYP, CBCSF
if model.verbose:
print(' loading {} instances of ISEGBC, IRCHBC, ISFBCTYP, ' \
'CBCSF...'.format(ntmp))
current_sf = 0
if ntmp > 0:
current_sf = np.empty((ntmp), dtype=dtype)
for ibnd in range(ntmp):
line = f.readline()
m_arr = line.strip().split()
t = []
for ivar in range(3): # First three terms are not variable
t.append(m_arr[ivar])
cbcsf = len(current_sf.dtype.names) - 3
if cbcsf > 0:
for ivar in range(cbcsf):
t.append(m_arr[ivar + 3])
current_sf[ibnd] = tuple(t[:len(current_sf.dtype.names)])
# Convert ISEG IRCH indices to zero-based
current_sf['isegbc'] -= 1
current_sf['irchbc'] -= 1
current_sf = current_sf.view(np.recarray)
sf_stress_period_data[iper] = current_sf
else:
if model.verbose:
print(' No transient boundary conditions specified')
pass
# Construct and return SFT package
sft = Mt3dSft(model, nsfinit=nsfinit, mxsfbc=mxsfbc, icbcsf=icbcsf,
ioutobs=ioutobs, ietsfr=ietsfr, isfsolv=isfsolv,
wimp=wimp, cclosesf=cclosesf, mxitersf=mxitersf,
crntsf=crntsf, coldsf=coldsf, dispsf=dispsf, nobssf=nobssf,
obs_sf=obs_sf, sf_stress_period_data=sf_stress_period_data)
return sft