Peripheral macro

Purpose

The peripheral macro defines a peripheral compartment. It is equivalent to a compartment with two transfers of drug amount towards and from another base compartment. This base compartment must have been previously defined and referenced by its label. If the amount or concentration of the peripheral compartment are not outputted, then they do not need to be defined.

Arguments

Arguments for macro peripheral are:

  • kij or ki_j: Input rate from the compartment of label i. It also defines a label j for the peripheral compartment. Here, both labels i and j must be integers. If i and/or j are larger than 9, the syntax with the underscore is necessary. Mandatory.
  • kji or kj_i: Output rate to the compartment of label i. It also defines a label j for the peripheral compartment. Here, both labels i and j must be integers. If i and/or j are larger than 9, the syntax with the underscore is necessary. Mandatory.
  • amount: Name of variable defined as the amount within the compartment. Its dynamics are defined by dose absorptions, eliminations, and the transfer rates with other compartments. These dynamics can extend an ODE system that defines a component with this name.
  • volume: Name of predefined variable to use as the volume of the compartment. It enables to define concentration. The default value is 1. If the volume is not defined, the concentration cannot be defined.
  • concentration: Name of the variable defined as the concentration within the peripheral compartment.

Example

PK:
; definition of a peripheral compartment with cmt=2 with rates k12 and k21,
; an amount called Ap, a volume V2, and a concentration Cp
peripheral(k12, k21, amount=Ap, volume=V2, concentration=Cp)
; definition of a peripheral compartment with cmt=3, linked to compartment 1, 
; with rates k13 and k31 a volume equals by default to 1
peripheral(k13, k31)
; with compartments numbers larger than 9 
peripheral(k2_13, k13_2)

Rules and best practices

  • To use inter-compartment clearance Q and peripheral volume V2 as parameters instead of k12 and k21, the syntax is: 
    peripheral(k12=Q/V, k21=Q/V2)
  • We encourage the user to use all the fields in the macro to guarantee non confusion between concentration, amount, …
  • Format restriction (non compliance will raise an exception)
    • The values after k are necessarily an integer (related to predefined compartment id).
    • The value after kij= can be either a double or replaced by an input parameter. Calculations are not supported.
    • The value after amount= and concentration= are necessarily strings.
    • The value after volume= can be either a double or replaced by an input parameter. Calculations are not supported.