initCRMElEnergyTermGenerator Interface

interface
private module subroutine initCRMElEnergyTermGenerator(this, envObj, crmData, generatorTag, electronEnergyVarName, includedTransitionIndices)

Arguments

Type IntentOptional Attributes Name
class(CRMElEnergyTermGenerator), intent(inout) :: this
type(EnvironmentWrapper), intent(in), target :: envObj

Environment wrapper used to get species data, partition info, etc.

type(ModelboundCRMData), intent(in) :: crmData

CRM data object used to get transition data

character(len=*), intent(in) :: generatorTag
character(len=*), intent(in) :: electronEnergyVarName

Name of electron energy variable (used as evolved var)

integer(kind=ik), intent(in), optional, dimension(:) :: includedTransitionIndices

Optional list of transitions to be included in source calculations by this generator. Defaults to all transitions that include electrons in ingoingStates

Description

Constructor routine for CRM energy source/sink term generator