pbpk physiology¶
The physiology of the PBPK library: the reference physiology and its scaling, the populations, the impairment, the observers and the sinks, see Physiology, Impairment and Observers.
physiology¶
The standard human physiology and its scaling to an individual.
The physiology is a set of SBML parameters of the top model. The covariates
of the individual (BW, HEIGHT, AGE) and the factors of organ function
are constant parameters which an experiment changes before the simulation,
as it changes BW today; everything else follows from them by initial
assignments on constant parameters, which sbmlsim evaluates again after the
changes of an experiment (a value which no rule recomputes during the
integration keeps the compiled model small and fast to load):
- the reference values of the sex of the build (ICRP 89,
data/physiology_human.toml); the sex is chosen when the model is built, a study of both sexes uses one model per sex; - the default individual (
BW,HEIGHT,AGE) is the reference individual of the sex of the population of the build (pkpdsim.pbpk.populations, ICRP 89 by default); the reference anatomy stays ICRP 89 for every population, the organs of another population's individual follow from the scaling; - body mass index, body surface area (Du Bois 1916) and fat-free mass (Janmahasatian 2005);
- the tissues scale as in Huisinga 2012 (eqs. 9, 10, 12): brain is constant,
skin scales with the body surface area, the other lean organs and the blood
with the fat-free mass less brain and skin (
SV_tis); adipose is the remainder of the body weight; - the cardiac output scales as the tissues,
SV_tis(Huisinga 2012 eq. 13), and the organ flows are fractions of it, renormalised over the organs so that they sum to the cardiac output; - the GFR scales with the body surface area.
An organ volume is the volume of its tissue and its blood,
M<o>/density + blood*Vblood; the body weight is the mass of the tissues
without blood and of the blood, sum(M<o>) + Vblood*rho_blood. The vascular
fraction of an organ volume is its blood, blood*Vblood/V<o>, so that the
vascular spaces of the organs and the pools are the blood volume for every
individual; the interstitial fraction is the interstitial fraction of the
tissue without blood (Schmitt 2008) times the tissue share 1 - f_vas.
A covariate or a factor of organ function is an initial value: changed before
the simulation (a change of an experiment, init(...) in roadrunner), every
quantity which depends on it follows; changed during a simulation, nothing
follows (unless the definition names it dynamic, see
pkpdsim.pbpk.builder).
The impaired organ function (pkpdsim.pbpk.impairment) multiplies cardiac
output, the blood flows, the GFR, the hematocrit and the kidney mass by its
factors (factors of physiology_objects); without them the physiology is
the healthy one.
LEAN_ORGANS
module-attribute
¶
The organs whose tissue mass scales with the individual; adipose is the rest.
DEFAULT_POPULATION
module-attribute
¶
The population of a model which does not choose one (pkpdsim.pbpk.populations).
AGE_DEFAULT
module-attribute
¶
The age of an individual if an experiment does not set it (yr).
MODEL_DEFAULT
module-attribute
¶
The notes of a parameter whose value is a choice of the model, not data.
LIVER_DEFAULTS
module-attribute
¶
LIVER_DEFAULTS = {ids.F_SHUNT: 0.0, ids.F_FUNCTIONAL: 1.0}
The healthy liver: no portosystemic shunt, all tissue functional. The
values at runtime are those of the hepatic impairment (pkpdsim.impairment),
which sets them as an experiment sets a covariate.
Sex
¶
Bases: StrEnum
The sex of a model build, the sex of its reference individual.
ReferenceIndividual
dataclass
¶
ReferenceIndividual(
sex,
bw,
height,
gfr,
volumes,
tissue_volumes,
intracellular_volumes,
lumen_volumes,
)
The reference individual of a sex (ICRP 89, data/physiology_human.toml).
The individual whose anatomy the physiology scales, the default individual of the populations of ICRP 89: a model which states a value of the hand-written models per litre of an organ or per kg of body weight converts it with these numbers instead of copies of them.
Attributes:
| Name | Type | Description |
|---|---|---|
sex |
Sex
|
the sex. |
bw |
float
|
the body weight [kg], |
height |
float
|
the height [cm], |
gfr |
float
|
the healthy GFR [l/min], the GFR at renal function 1 of the
default individual ( |
volumes |
Mapping[Organ, float]
|
the organ volumes with their blood |
tissue_volumes |
Mapping[Organ, float]
|
the tissue volumes without blood [l]
( |
intracellular_volumes |
Mapping[Organ, float]
|
the volumes of the cells of the organs [l],
|
lumen_volumes |
Mapping[str, float]
|
the fluid volumes of the lumen segments of the
segmented intestine by their token ( |
physiology_objects
¶
physiology_objects(
sex=MALE, factors=None, population=DEFAULT_POPULATION
)
The parameters and initial assignments of the standard human physiology.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sex
|
Sex
|
the sex of the model: its reference values and the default
individual ( |
MALE
|
factors
|
Mapping[str, str] | None
|
the factors of the impaired organ function by the id of the
quantity they multiply ( |
None
|
population
|
str
|
the population ( |
DEFAULT_POPULATION
|
Returns:
| Type | Description |
|---|---|
list[Sbase]
|
The constant parameters and their initial assignments of the top model. |
Raises:
| Type | Description |
|---|---|
ValueError
|
if the reference individual leaves no mass for adipose, a unit of the data is not the unit of the model, a factor names no quantity of the physiology with an initial assignment, or the population is unknown. |
reference_fractions
¶
normal_gfr
¶
The GFR per 1.73 m2 body surface area of a reference individual.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sex
|
Sex
|
the sex of the reference individual. |
required |
Returns:
| Type | Description |
|---|---|
float
|
The reference GFR scaled to 1.73 m2 with the reference body surface |
float
|
area (l/min), the GFR of the normal renal function. |
reference_tissue_volumes
¶
The tissue volumes of the organs of a reference individual.
The tissue volume of an organ is its volume without its blood,
V<o>*(1 - f_vas_<o>) = M<o>/density; adipose is the remainder of the
body weight, as in the model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sex
|
Sex
|
the sex of the reference individual. |
required |
Returns:
| Type | Description |
|---|---|
dict[Organ, float]
|
The tissue volume (l) by organ. |
reference_hematocrit
¶
The hematocrit of a reference individual.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sex
|
Sex
|
the sex of the reference individual. |
required |
Returns:
| Type | Description |
|---|---|
float
|
The hematocrit of physiology_human.toml. |
reference_individual
cached
¶
The reference individual of a sex.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sex
|
Sex
|
the sex of the reference individual. |
required |
Returns:
| Type | Description |
|---|---|
ReferenceIndividual
|
Its body weight, height, healthy GFR, organ, cell and lumen volumes. |
populations¶
The populations: the reference individual and the distributions of the covariates.
A population is a set of data of the library (data/populations/<key>.toml):
the reference covariates of each sex (body weight, height and, where the data
give it, the age), which become the default individual of a model, and the
distributions of the covariates for a later sampler of virtual individuals.
The reference anatomy stays ICRP 89 (data/physiology_human.toml): the organ
volumes and flows of a population's reference individual follow from the
covariate scaling of pkpdsim.pbpk.physiology (Huisinga 2012) at its body
weight and height. The population is chosen when the model is built
(PBPKDefinition.population), the European reference individuals of ICRP 89
are the default.
The distributions are data of the library and never SBML distrib
uncertainties: run_simulation --uncertainty draws every parameter with a
distrib uncertainty and must only draw the uncertainty of a fit.
The populations:
european_icrp: the ICRP 89 reference individuals (the default); ICRP 89 gives reference values, not distributions, so the population has none;white_american_nhanes,black_american_nhanes,mexican_american_nhanes: adults of 20 to 49 years of the NHANES examinations 2013-2018 as preprocessed by httk (HTTK-Pop, Ring 2017), survey-weighted means and standard deviations;east_asian_tanaka: the Asian Reference Man of Tanaka 1996 (Tables 9 and 10, 20 to 49 years) with the distributions of the Japanese of the same tables.
PK-Sim also offers a Japanese population (based on Japanese national
statistics of 2015). Its primary data were not read, so the library has no
japanese population; the Japanese data of Tanaka 1996 (1976 to 1988) are
the distributions of east_asian_tanaka.
DEFAULT_POPULATION
module-attribute
¶
The population of a model which does not choose one (pkpdsim.pbpk.populations).
COVARIATES
module-attribute
¶
The covariates a population gives reference values for.
Distribution
dataclass
¶
The distribution of a covariate in a population.
Attributes:
| Name | Type | Description |
|---|---|---|
kind |
Literal['normal', 'lognormal']
|
|
mean |
float
|
the mean. |
sd |
float
|
the standard deviation. |
unit |
UnitDefinition
|
the unit of mean and standard deviation. |
source |
str
|
the key of the source in |
notes |
str | None
|
where the numbers come from. |
Population
dataclass
¶
A population: the reference individual and the covariate distributions per sex.
Attributes:
| Name | Type | Description |
|---|---|---|
key |
str
|
the key of the population, |
name |
str
|
the name. |
source |
str
|
the key of the source of the population in |
reference |
Mapping[Sex, Mapping[str, Value]]
|
the reference covariates ( |
covariates |
Mapping[Sex, Mapping[str, Distribution]]
|
the distributions of the covariates of each sex. |
population
¶
Get a population.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
the key of the population. |
required |
Returns:
| Type | Description |
|---|---|
Population
|
The population. |
Raises:
| Type | Description |
|---|---|
ValueError
|
if there is no population of the key. |
impairment¶
The impaired organ function: parameter vectors on the physiology.
Impairment is never a structurally different model: three severities of the
top model set factors on the quantities of the healthy physiology, the
liver and the binding to plasma proteins (data/impairment.toml, every
number with its source; a value which no publication read gives is a model
choice):
CP_severity: liver cirrhosis, 0 healthy, 1, 2, 3 the Child-Pugh classes A, B, C; a severity between the classes interpolates every factor linearly (scans and fits use intermediate values). It sets the functional fractionf_functionaland the portosystemic shuntf_shuntof the liver, the hepatic arterial and the renal blood flow, the cardiac output (cardiac index; the organs without a factor of their own close the cardiac output to it), the GFR, albumin and alpha-1-acid glycoprotein (and so fu) and the activity of the enzymes and transporters of the liver.f_renal_function: chronic kidney disease by the GFR relative to healthy (the factor of the physiology); its GFR per 1.73 m2 (eGFR) gives the stage (normal, mild, moderate, severe, end stage), which sets the binding capacity of the plasma proteins (and so fu). The factors are piecewise linear in the eGFR through anchor points at the stage midpoints ([ckd] stage_anchorof the data, a model choice: continuous covariate for scans and fits; stage midpoints): 1 from 90 ml/min/1.73 m2, the mild value at 75, the moderate value at 45, the severe value at 22.5 and the end stage value at 7.5 and below, linear in between (from 90 to 75 from 1 to the mild value), so a scan or fit off_renal_functionsees no step. The binding to albumin and alpha-1-acid glycoprotein follows the CKD profile of its protein ([ckd.binding]of the data): albumin falls in concentration and in the binding function of its molecule, AAG rises in concentration; the binding to an unknown protein follows the binding capacity of the plasma proteins (plasma_protein). The switchCKD_hepatic(0 off, 1 on) adds the reduced activity of hepatic CYP2D6 and OATP1B. The tubular capacity of the kidney (every metabolism and transport of the kidney) followsf_renal_functioncontinuously,1 - f_tubular + f_tubular*f_renal_functionwith the sharef_tubular1 of the intact nephron hypothesis ([ckd] tubular_capacityof the data, a model choice; the kidney owns the factor,pkpdsim.pbpk.organ).HF_severity: heart failure, 0 healthy, 1 to 4 the NYHA classes I to IV, interpolated: the blood flows of liver and portal organs, kidney and skin, adipose and muscle are reduced, the cardiac output is the sum of the flows, the GFR follows the renal blood flow (which is not monotonic in the class, NYHA IV above NYHA III, as measured by Leithe 1984).
The hematocrit (anaemia of cirrhosis and CKD, combined multiplicatively on the hematocrit of the sex of the build), the kidney volume and blood flow and the gastric emptying and small intestinal transit of CKD have their factors, which are 1 until a publication with the healthy reference is read (the data say why).
Each condition has its factors fcp_<key>, fckd_<key>, fhf_<key>; the
factor of all conditions on a quantity is fimp_<id> (fimp_GFR,
fimp_Qki, fimp_HCT), their product. Blood flows: every organ flow is its
fraction of the cardiac output without impairment (CO_base) times
fimp_Q<o>, and the cardiac output is CO_base times
fimp_CO = sum fQ<o>*fimp_Q<o>, so the flows sum to it.
Plasma binding (McNamara 2002): fu = 1/(1 + f*(1 - fu_ref)/fu_ref) with the
binding factor f, the factor of the binding protein in cirrhosis
(fimp_albumin, fimp_agp, 1 for an unknown protein) times the CKD factor of
the binding: the CKD profile of the protein (fimp_albumin_ckd,
fimp_agp_ckd, the product of its rows of [ckd.binding]), for an unknown
protein one over the factor of the binding capacity fimp_plasma_protein
(fu of a strongly bound substance rises by it). fu stays below 1. A binding
with ckd=False (measured unchanged in renal impairment) leaves out the CKD
factor, so f is the factor of the binding protein alone. The parameters of
the CKD profile of a protein are created only when a substance binds to it
with the CKD factor. Enzymes and transporters: a rate of a
protein in the liver runs with f_<protein>*fimp_<protein>, the organ-local
base activity (genotype, interactions of an experiment, LI__f_cyp3a4)
times the input fimp_<protein> of the impairment (fimp_li_<protein> of
the body), so both act multiplicatively.
All are initial assignments (pkpdsim.pbpk.physiology): set the severities
before the simulation, as a covariate; a severity which changes during a
simulation is named in PBPKDefinition.dynamic. f_shunt and
f_functional stay parameters an experiment may set directly. All
severities 0 give the healthy model: every factor is 1.
GASTRIC_EMPTYING
module-attribute
¶
GASTRIC_EMPTYING = ids.impairment_factor('t_stomach')
The factor on the transit time of the stomach, an input of the intestine.
SI_TRANSIT
module-attribute
¶
SI_TRANSIT = ids.impairment_factor('t_si')
The factor on the transit times of the small intestine, an input of the intestine.
organ_activity
¶
Get the local input of the impairment on a protein in an organ.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organ
|
Organ
|
the organ. |
required |
protein
|
str
|
the protein of a process of the organ. |
required |
Returns:
| Type | Description |
|---|---|
str | None
|
|
str | None
|
replaced by |
physiology_factors
¶
Get the factors of the impairment on the quantities of the physiology.
Returns:
| Type | Description |
|---|---|
dict[str, str]
|
The factor (formula) by the id of the quantity it multiplies, for |
dict[str, str]
|
|
dict[str, str]
|
sum of the impaired flows), the flows, the GFR (at renal function 1, |
dict[str, str]
|
|
dict[str, str]
|
kidney mass. |
unbound_fraction_notes
¶
Get the notes of the fraction unbound in plasma of a substance.
The notes say what unbound_fraction gives: the reference fraction scaled
with the binding protein under impairment, scaled with the binding
capacity of chronic kidney disease alone (an unknown protein with the CKD
factor), the reference fraction itself where no factor applies (an
unknown protein without the CKD factor), or no binding.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
s
|
Substance
|
the substance. |
required |
Returns:
| Type | Description |
|---|---|
str
|
The notes of |
unbound_fraction
¶
Get the formula of the fraction unbound in plasma of a substance under impairment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
s
|
Substance
|
the substance. |
required |
Returns:
| Type | Description |
|---|---|
str
|
|
str
|
scaling |
str
|
the factor of the binding protein in cirrhosis times the CKD profile |
str
|
of the protein ( |
str
|
protein has no factor of cirrhosis and its CKD factor is one over the |
str
|
factor of the binding capacity |
str
|
of a strongly bound substance by itself |
str
|
( |
str
|
bound substance rises less (fu_ref 0.5 at a factor 2.5: 0.71, not |
str
|
1.25). A binding with |
str
|
protein alone; with an unknown protein as well no factor applies and |
str
|
the result is |
ckd_unbound_fractions
¶
Get the fraction unbound of a substance at the CKD stages.
The fu of unbound_fraction without cirrhosis at the values of the
stages mild, moderate, severe and end stage of the CKD factor of its
binding (the profile of its protein, [ckd.binding], or one over the
factor of the binding capacity plasma_protein of an unknown protein):
the factors are linear in the eGFR between the anchors of the stages and
constant below the end stage, so the fu of every renal function lies
between these values (and the reference fu of renal function 1).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
s
|
Substance
|
the substance. |
required |
Returns:
| Type | Description |
|---|---|
dict[str, float]
|
The fu by stage; empty for a substance whose fu CKD does not change |
dict[str, float]
|
(no binding, |
impairment_objects
¶
Get the parameters of the impaired organ function of the top model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
definition
|
PBPKDefinition
|
the definition (the proteins of the liver). |
required |
Returns:
| Type | Description |
|---|---|
list[Sbase]
|
The severities, the factors of every condition and of all conditions |
list[Sbase]
|
(initial assignments) and the initial assignments of |
list[Sbase]
|
|
list[Sbase]
|
|
observers¶
The observers of a PBPK model: assignment rules of the top model, no states.
An observer reads the pool species and the outflow concentrations of the
organs and changes nothing, so it conserves mass. Per substance <s>:
C<pool>_free_<s> = fu*C<pool>_<s>, the unbound plasma concentration of a pool (ar,ve,po);C<pool>_blood_<s>, the blood concentration of a pool,(1-HCT)*C + HCT*C_bc:BP*Cunless the blood cells are kinetic;Chv_<s>, the hepatic vein: the outflow of the liver mixed with the portosystemic shunt by their flows,((1-f_shunt)*Qh*Cout_li + f_shunt*(Qha*Car + Qpo*Cpo))/Qh, withChv_free_<s>andChv_blood_<s>;Carm_<s> = sum w*C, the arm vein (peripheral venous) sampling site: the venous plasma outflows of organs and the arterial plasma mixed with the weightsw_arm_<site>of a preset ofdata/arm_vein.toml(PBPKDefinition.arm_vein, by default the mix of skin and muscle of the PK-Sim documentation);Carm_free_<s>andCarm_blood_<s>as for the pools.
The tissue concentrations are the species of the organs themselves, their
unbound concentrations Cu_<part>_<s> observers of the organs, the amounts
in urine and feces the sink species, the urinary excretion rate
Rurine_<s> an output of the kidney.
A definition adds observers of its own (Observer, PBPKDefinition.observers,
e.g. the sum of two metabolites): parameters of the top model over the ids
of the top model, appended after the observers of the library. An observer
names a species or an unbound concentration of an organ by its flat id
(MU__Cti_<s>, LI__Cu_ic_<s>, an amount MU__A<x>), which the organ
exposes as a PD input is exposed (pkpdsim.pbpk.builder). An observer which
reads a state, directly or through other observers (a species, an observer
of the library, an output of an organ or a PD component, a dynamic
parameter, time), is an assignment rule; an observer of constants only is
a constant with an initial assignment, evaluated after the changes before
the simulation (an assignment rule of constants would slow the compile of
the model).
The intestine adds readouts on request (PBPKDefinition.readouts,
intestine_readouts): the dissolved amount in its lumen Alumen_<s> and
the summed fluxes of the absorption Rabs_<s>, the efflux into the lumen
Reff_<s> and the loss to the feces Rfeces_<s>, outputs of the intestine
as Rurine_<s> is one of the kidney.
TIME
module-attribute
¶
The symbol of the simulation time in the symbols of a formula.
Observer
dataclass
¶
An observer of a definition: a parameter of the top model with its formula.
Attributes:
| Name | Type | Description |
|---|---|---|
sid |
str
|
the id of the observer, an id of the top model. |
formula |
str
|
the formula (SBML L3 infix) over the ids of the top model:
the pools, the sinks, the observers of the library and of the
definition, the covariates, the outputs of the organs, the
readouts; and a species or an unbound concentration of an organ
by its flat id ( |
unit |
UnitDefinition
|
the unit of the formula; a unit which is no unit of |
name |
str
|
the name of the observer. |
notes |
str | None
|
the notes of the observer. |
OrganOutput
dataclass
¶
An output of an organ which replaces the parameter of the top model of its id.
The parameter is created by the composition (pkpdsim.pbpk.builder):
an element of an organ which a PD component or an observer reads, a
readout of the intestine.
Attributes:
| Name | Type | Description |
|---|---|---|
unit |
UnitType
|
the unit of the parameter. |
name |
str
|
the name of the parameter. |
kind |
str
|
the kind of its annotation ( |
text |
str
|
the start of its notes, followed by |
constant |
bool
|
the output is a constant of the organ (a constant of the generated steady state), not an assignment rule. |
formula_symbols
¶
Get the ids a formula reads, with libsbml's parser of SBML L3 infix.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
formula
|
str
|
the formula; the units of its numbers ( |
required |
Returns:
| Type | Description |
|---|---|
set[str]
|
The ids of the formula, |
Raises:
| Type | Description |
|---|---|
ValueError
|
if the formula cannot be parsed, with the message of libsbml. |
formula_functions
¶
Get the functions a formula calls which are no functions of SBML L3 infix.
Such a call (foo(x)) reads a function definition of the model; the
models of the library define none.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
formula
|
str
|
the formula. |
required |
Returns:
| Type | Description |
|---|---|
set[str]
|
The names of the called functions which are no built-in functions |
set[str]
|
( |
Raises:
| Type | Description |
|---|---|
ValueError
|
if the formula cannot be parsed, with the message of libsbml. |
definition_observer_objects
¶
Get the parameters and the rules of the observers of a definition.
The ids, the symbols of the formulas and whether an observer reads a
state are checked when the model is composed (pkpdsim.pbpk.builder).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
observers
|
Iterable[Observer]
|
the observers of the definition, their formulas over the ids of the top model. |
required |
constant
|
Collection[str]
|
the ids of the observers which read constants only: a constant with an initial assignment, every other observer an assignment rule. |
()
|
Returns:
| Type | Description |
|---|---|
list[Sbase]
|
The parameters with their assignment rules or initial assignments, |
list[Sbase]
|
annotated as observers. |
readout_ids
¶
Get the ids of the readouts of the intestine of substances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
substances
|
Iterable[str]
|
the substance ids. |
required |
Returns:
| Type | Description |
|---|---|
dict[str, tuple[str, str]]
|
By readout id ( |
dict[str, tuple[str, str]]
|
|
dict[str, tuple[str, str]]
|
|
intestine_readouts
¶
Add the readouts of a definition to the model definition of its intestine.
Every readout is a parameter of the intestine with its assignment rule and an output port, which replaces the parameter of its id in the top model, as the urinary excretion rate of the kidney does. The sums are taken over the species and the reactions of the intestine, so that they hold for every intestine with a lumen (segmented, single lumen):
Alumen_<s>: the dissolved amount in the lumen,sum V*Cof the lumen speciesClumen_<seg>_<s>(mmole);Rabs_<s>: the fluxes from a lumen species into the wall of the substance (the mucosaCmu_<seg>_<s>, else a species of the wall), the absorption and an apical influx (mmole/min);Reff_<s>: the fluxes from the wall into the lumen, the apical efflux (mmole/min);Rfeces_<s>: the net flux of the intestine into the fecesAfeces_<s>(mmole/min); with an intestine with a lumen every flux into the feces is one of the intestine, so it integrates toAfeces_<s>;Aabs_<s>: the amount absorbed since the start, the integral of the fluxes ofRabs_<s>, a state of the intestine (mmole);Fa_<s>: the gross absorbed fraction of the oral dose,Aabs_<s>over the oral dose given until then (the dose statesPODOSE_<s>andSOLDOSE_<s>overMr_<s>plus what the intestine applied of them, the stateAapp_<s>), 0 before a dose: before the first pass of the wall and the liver, so above the bioavailability; the absorption of a substance which reaches the lumen otherwise (the bile, an efflux) counts as well, so it can exceed 1.
Aabs_<s> and Aapp_<s> are states which nothing drains (accumulating
states, which the equilibration sets back as it sets back the sinks).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
md
|
ModelDefinition
|
the model definition of the intestine, changed in place. |
required |
readouts
|
Sequence[str]
|
the readouts of the definition ( |
required |
substances
|
Iterable[str]
|
the substance ids of the definition. |
required |
Returns:
| Type | Description |
|---|---|
dict[str, OrganOutput]
|
The outputs by id. |
Raises:
| Type | Description |
|---|---|
ValueError
|
naming a readout of a substance without lumen species, or whose sum has no flux. |
arm_vein_weights
¶
Get the weights of a preset of the arm vein.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
preset
|
str
|
the name of the preset, e.g. |
required |
Returns:
| Type | Description |
|---|---|
dict[Organ | Pool, Value]
|
The weight of every organ outflow or pool of the mix with its source. |
Raises:
| Type | Description |
|---|---|
ValueError
|
if the preset is unknown or names neither an organ nor a pool. |
observer_objects
¶
Get the observers of a definition.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
definition
|
PBPKDefinition
|
the definition. |
required |
Returns:
| Type | Description |
|---|---|
list[Sbase]
|
The weights of the arm vein and the parameters with their assignment |
list[Sbase]
|
rules of every substance. |
sinks¶
The sinks of the body: urine, feces and bile.
Every substance has the amounts in urine Aurine_<s> and feces Afeces_<s>
(compartments of amounts, Vurine and Vfeces) and the bile Cbile_<s> in
Vbile, which drains with first order k_bile into the duodenum of the
intestine (pkpdsim.pbpk.variants.intestine, which owns the lumen and that
transit); with the standard organs as intestine, which have no lumen, the
bile drains into the feces.
sink_objects
¶
Get the sinks of a definition.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
definition
|
PBPKDefinition
|
the definition. |
required |
lumen
|
bool
|
the intestine has a lumen, which takes the bile; without one the bile drains into the feces here. |
True
|
Returns:
| Type | Description |
|---|---|
list[Sbase]
|
The compartments, parameters and species of the top model, and the |
list[Sbase]
|
transit of the bile into the feces without lumen. |