imod.mf6.SourceSinkMixing.from_flow_model#
- static SourceSinkMixing.from_flow_model(model: GroundwaterFlowModel, species: str, print_flows: bool = False, save_flows: bool = False, validate: bool = True, is_split: bool = False)[source]#
Derive a Source and Sink Mixing package from a Groundwater Flow model’s boundary conditions (e.g. GeneralHeadBoundary). Boundary condition packages which have the
concentration
variable set are included.- Parameters:
model (GroundwaterFlowModel) – Groundwater flow model from which sources & sinks have to be inferred.
species (str) – Name of species to create a transport model for. This name will be looked for in the
species
dimensions of theconcentration
argument.print_flows (({True, False}, optional)) – Indicates that the list of general head boundary flow rates will be printed to the listing file for every stress period time step in which “BUDGET PRINT” is specified in Output Control. If there is no Output Control option and PRINT FLOWS is specified, then flow rates are printed for the last time step of each stress period. Default is False.
save_flows (({True, False}, optional)) – Indicates that general head boundary flow terms will be written to the file specified with “BUDGET FILEOUT” in Output Control. Default is False.
validate (({True, False}, optional)) – Flag to indicate whether the package should be validated upon initialization. This raises a ValidationError if package input is provided in the wrong manner. Defaults to True.
is_split (({True, False}, optional)) – Flag to indicate if the simulation has been split into partitions.