... | ... | @@ -8,7 +8,7 @@ As discussed in the [system](https://pulse.kitware.com/_system_methodology.html) |
|
|
|
|
|
System should strive to encapsulate a model in a single function that is called from the system preprocess function. You may need to just add code to an existing function, or create a whole new function if this is completely new functionality.
|
|
|
|
|
|
##### Adding new member variables
|
|
|
##### Adding System Member Variables
|
|
|
|
|
|
##### System Initialization/Setup
|
|
|
|
... | ... | @@ -18,11 +18,15 @@ System should strive to encapsulate a model in a single function that is called |
|
|
|
|
|
##### Compartments and Circuits
|
|
|
|
|
|
###### Circuit Data
|
|
|
|
|
|
As described in the [system](https://pulse.kitware.com/_system_methodology.html) documentation, [circuit data](https://pulse.kitware.com/_circuit_methodology.html#circuit-features) can have 3 values: `baseline`, `current`, and `next`. Since we are pulling data from the circuit in our physiology model algorithm functions that are called during PreProcess, to use the latest value of the circuit node/path data, use the `next` value (ex. `GetNextVolume()`). Each system PreProcess method is called in a set order determined by the engine implementation, and the `next` value could have any updates from other systems called previously to the system you are working in. For example, if your system wants to update a node's resistance you should pull the `next` value and modify it via a scale factor equation* in order to preserve any changes to this `next` value made from a previously called PreProcss method that is called before your systems PreProcess method. The `current` value is the value calculated from the circuit solver, you should never modify it, but you can use it as well as the `baseline` value as a reference in computing a scale factor to apply to the `Next` value. So we always use `Next`. If no system modifies it then it is the same as current anyway. It is possible that you may want to modify the baseline, you should only do this ...
|
|
|
|
|
|
*A scale factor equation is where...
|
|
|
|
|
|
#### Testing Functionality
|
|
|
|
|
|
##### Adding a new Scenario
|
|
|
|
|
|
##### Validation
|
|
|
|
|
|
|
|
|
|
... | ... | |