Simple transition object with a fixed rate and energy, and single ingoing and outgoing state. The default energy rate is set to rate*energy, and the momentum rate is 0
Type | Visibility | Attributes | Name | Initial | |||
---|---|---|---|---|---|---|---|
logical, | public | :: | userDefined | = | .false. |
True only if user explicitly sets it to true |
|
real(kind=rk), | private | :: | transitionEnergy |
Getter for userDefined
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Object), | intent(in) | :: | this |
Set userDefined to .true.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Object), | intent(inout) | :: | this |
Set userDefined to .false.
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Object), | intent(inout) | :: | this |
Getter for ingoingStates
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(in) | :: | this |
Getter for outgoingStates
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(in) | :: | this |
Setter for both ingoing and outgoing states
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(inout) | :: | this | |||
integer(kind=ik), | intent(in), | dimension(:) | :: | inStates |
Ingoing state IDs |
|
integer(kind=ik), | intent(in), | dimension(:) | :: | outStates |
Outgoing state IDs |
Setter for rate values
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(inout) | :: | this | |||
real(kind=rk), | intent(in), | dimension(:) | :: | rate |
Getter for rate values
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(in) | :: | this |
Setter for rateMomentum values
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(inout) | :: | this | |||
real(kind=rk), | intent(in), | dimension(:) | :: | rate |
Getter for rateMomentum values
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(in) | :: | this |
Setter for rateEnergy
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(inout) | :: | this | |||
real(kind=rk), | intent(in), | dimension(:) | :: | rate |
Getter for rateEnergy
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(in) | :: | this |
Setter for crossSection
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(inout) | :: | this | |||
real(kind=rk), | intent(in), | dimension(:,:) | :: | crossSection |
Set cross-section values in column col
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(inout) | :: | this | |||
real(kind=rk), | intent(in), | dimension(:) | :: | crossSection | ||
integer(kind=ik), | intent(in) | :: | col |
Get cross-section values from column col
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(in) | :: | this | |||
integer(kind=ik), | intent(in) | :: | col |
Check whether rates in this transition include an electron density factor
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(in) | :: | this |
Setter for rateContainsElDensity
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(inout) | :: | this | |||
logical, | intent(in) | :: | includeDens |
Setter for csDim
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(inout) | :: | this | |||
integer(kind=ik), | intent(in) | :: | csDim |
Getter for csDim
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(in) | :: | this |
Getter for rate array length
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(in) | :: | this |
Default update routine - does nothing
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(Transition), | intent(inout) | :: | this | |||
type(VariableContainer), | intent(in) | :: | varCont |
Variable container used in update |
||
class(ModelSurrogate), | intent(in), | optional | :: | hostModel |
Optional host model reference for callbacks during update |
|
class(ModelboundData), | intent(in), | optional | :: | hostData |
Optional host data reference for callbacks during update |
|
integer(kind=ik), | intent(in), | optional | :: | updatePriority |
Priority for this update call |
Initialization routine for SimpleTransition object
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(SimpleTransition), | intent(inout) | :: | this | |||
integer(kind=ik), | intent(in) | :: | locNumX |
Local number of spatial cells |
||
integer(kind=ik), | intent(in) | :: | inState |
Pre-transition state |
||
integer(kind=ik), | intent(in) | :: | outState |
Post-transition state |
||
real(kind=rk), | intent(in) | :: | energy |
Transition energy |
||
real(kind=rk), | intent(in) | :: | fixedRate |
Fixed transition rate |
Returns array representing energy cost of this transition
Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
class(SimpleTransition), | intent(in) | :: | this |