Add "Urine compartment emptying" as an event template to PK-Sim

[sfrechen]

Similar as the gallblader emptying event, an event is required to empty the urine compartment.
The event should be available as a selection in the "Create Event" menu. No parameters needed to be specified by the user. The user should simply remove all compounds from the urine compartment (set all amounts to zero).
The event should then be added to a simulation via the "Events" tab, potentially at multiple times for one simulation.

@Yuri05

[AnnikaRPS]

I strongly agree!

[msevestre]

@sfrechen Do we need a parameter such as for Gallbladder emptying?

@Yuri05 Why do we have this parameter? Is this to turn the event on and off without changing the sim structure?

[sfrechen]

@sfrechen Do we need a parameter such as for Gallbladder emptying?

@Yuri05 Why do we have this parameter? Is this to turn the event on and off without changing the sim structure?

Yes, we need such an event with such a single parameter. So pretty simple :-)

[msevestre]

No parameters needed to be specified by the user.

That's why I was confused ah ah :)

For gallbladder, it does something a bit funky

There is a parameter called Time to complete gallbladder refilling. Do we have something like this for Urine as well?

[sfrechen]

There is a parameter called Time to complete gallbladder refilling. Do we have something like this for Urine as well?

No. We just need the option to empty the compartment. Nothing more.

[msevestre]

@Yuri05 Can we talk about this when you have time?

[msevestre]

So it's not as easy as it may seem.
We have no way to set all amount in a compartment to zero. GallBladder emptying is done via a transporter from GallBladder to Liver/Duodenum

Option #1. We create a transporter UrineEmptying from Urine into a new compartment (toilet?:)) and we turn that transport on with an event. That way we can empty everuthing at once provided that the transport rate is high (whatever that means)

Option #2. We need to list the molecule to reset explicitely in the event. The problem is that the event will not work in MoBi when adding new molecules (as they need to be listed explicitely)

Thougths?

[msevestre]

@Yuri05 There is this table here (tab_event_molecule)

5957,EVENT,Urine_Emptying_StartEvent,4914,DRUG,Events,Zero_Rate,1,1

Which creates this

--------------- SWITCHES ----------
Event: Urine_Emptying_StartEvent
Path: as|Events|PIPI|PIPI_1|Urine_Emptying_StartEvent
Condition: Urine_Emptying_Enabled AND (Time=StartTime)
StartTime: as|Events|PIPI|PIPI_1|Start time(120 [min])
Urine_Emptying_Enabled: as|Events|PIPI|Urine compartment emptying enabled(1)
Time: as|Time(0 [min])
Assignments:
Path: as|Organism|Kidney|Urine|Alfentanil
UseAsValue: True
Formula: 0

So somehow DRUG is replaced with Alfentanil...but only the first drug...maybe we can build upon this
I tried to apply two drugs but only the first one is added

[Yuri05]

So somehow DRUG is replaced with Alfentanil...but only the first drug...maybe we can build upon this
I tried to apply two drugs but only the first one is added

I was first wondering why... that's why. Lol
https://github.com/Open-Systems-Pharmacology/OSPSuite.Core/blob/eb53d542421fbb3c13fad936b547dfbd349c8ebb/src/OSPSuite.Core/Domain/Services/KeywordReplacerTask.cs#L83-L88

Actually this code should have been removed after we stopped support for 4.2 projects.
Also the immediate EHC emptying event should be removed from the PK-Sim database (is not used anymore as well)

So for now I see only Option 1 (Transport to 🚽 ) as solution. Or we need new keywords...

[msevestre]

Lol...I am going to remove that now....4.2 shot going on still

[msevestre]

Or we need new keywords...

I am going to try this.... "ALL_FLOATING".
This will only be used for Assignment for now

[msevestre]

Seems to work...