crm_dens_term_generator_procedures Submodule

Contains procedures associated with the CRMElEnergyTermGenerator class



Module Subroutines

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

Constructor routine for CRM energy source/sink term generator

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

module subroutine generateElEnergySourceTerms(this, mbData)

Generates and allocates parent implicit energy source terms

Arguments

Type IntentOptional Attributes Name
class(CRMElEnergyTermGenerator), intent(inout) :: this
class(ModelboundData), intent(in), optional :: mbData

elemental module subroutine finalizeCRMElEnergyGenerator(this)

Deallocate pointer component

Arguments

Type IntentOptional Attributes Name
type(CRMElEnergyTermGenerator), intent(inout) :: this