crm_dens_term_generator_procedures Submodule

Contains procedures associated with the CRMDensTermGenerator class

Uses

- Ancestors:
- crm_dens_term_generator_class

Module Subroutines

module subroutine initCRMDensTermGenerator(this, envObj, crmData, generatorTag, evolvedSpeciesIDs, includedTransitionIndices)

Constructor routine for CRM particle source term generator

Arguments

Type	Intent	Optional	Attributes		Name
class(CRMDensTermGenerator),	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
integer(kind=ik),	intent(in),	optional,	dimension(:)	::	evolvedSpeciesIDs	Optional list of species IDs for which this generator will build source. Defaults to all species.
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

module subroutine generatePartSourceTerms(this, mbData)

Generates and allocates parent implicit particle source terms

Arguments

Type	Intent	Optional	Attributes		Name
class(CRMDensTermGenerator),	intent(inout)			::	this
class(ModelboundData),	intent(in),	optional		::	mbData

elemental module subroutine finalizeCRMDensGenerator(this)

Deallocate pointer component

Arguments

Type	Intent	Optional	Attributes		Name
type(CRMDensTermGenerator),	intent(inout)			::	this