This PR introduces the possibility of adding regional multipliers for bulkvolume, permeability and porosity.
Contributor checklist
[x] :tada: This PR closes #394.
[x] :scroll: I have broken down my PR into the following tasks:
[x] Add bulkvolume_mult_regional_scheme, porosity_regional_schemeand permeability_regional_schemeto the model_parametersin _config_parser.py. Default values are individual, meaning no regional multiplier (alternatives are regions_from_simor global)
[x] Add bulkvolume_mult_regional, porosity_regionaland permeability_regional to the model_parametersin _config_parser.py. If the *_regional_scheme is individual the priors can be empty, otherwise they need to be defined (same way as the priors for individual tubes - not implemented possibility for different priors in different regions (such as for equilibrium regions or relative permeability)
[x] Add bulkvolume_mult_parameter_from_sim_model, porosity_parameter_from_sim_modeland permeability_parameter_from_sim_model, telling which region parameter to look for in the input simulation model if the *_regional_scheme is set to regions_from_sim.
[ ] :robot: I have added tests, or extended existing tests, to cover any new features or bugs fixed in this PR.
[x] :book: I have considered adding a new entry in CHANGELOG.md.
[ ] :books: I have considered updating the documentation.
This PR introduces the possibility of adding regional multipliers for bulkvolume, permeability and porosity.
Contributor checklist
bulkvolume_mult_regional_scheme
,porosity_regional_scheme
andpermeability_regional_scheme
to themodel_parameters
in_config_parser.py
. Default values areindividual
, meaning no regional multiplier (alternatives areregions_from_sim
orglobal
)bulkvolume_mult_regional
,porosity_regional
andpermeability_regional
to themodel_parameters
in_config_parser.py
. If the*_regional_scheme
isindividual
the priors can be empty, otherwise they need to be defined (same way as the priors for individual tubes - not implemented possibility for different priors in different regions (such as for equilibrium regions or relative permeability)bulkvolume_mult_parameter_from_sim_model
,porosity_parameter_from_sim_model
andpermeability_parameter_from_sim_model
, telling which region parameter to look for in the input simulation model if the*_regional_scheme
is set toregions_from_sim
.CHANGELOG.md
.