species_list_procedures Submodule

Contains module procedures associated with the species list class


Uses


Module Functions

pure module function getSpeciesFromID(this, id) result(spec)

Getter for species based on id

Arguments

Type IntentOptional Attributes Name
class(SpeciesList), intent(in) :: this
integer(kind=ik), intent(in) :: id

Return Value type(Species), allocatable

pure module function getSpeciesIDs(this) result(ids)

Getter for speciesIDs

Arguments

Type IntentOptional Attributes Name
class(SpeciesList), intent(in) :: this

Return Value integer(kind=ik), allocatable, dimension(:)

pure module function getSpeciesFromName(this, name) result(spec)

Getter for species based on name

Arguments

Type IntentOptional Attributes Name
class(SpeciesList), intent(in) :: this
character(len=*), intent(in) :: name

Return Value type(Species), allocatable

pure module function getSpeciesVarFromName(this, name, ind) result(var)

Return associated var with index ind of species with given name

Arguments

Type IntentOptional Attributes Name
class(SpeciesList), intent(in) :: this
character(len=*), intent(in) :: name
integer(kind=ik), intent(in) :: ind

Return Value character(len=:), allocatable

pure module function getSpeciesVarFromID(this, id, ind) result(var)

Return associated var with index ind of species with given id

Arguments

Type IntentOptional Attributes Name
class(SpeciesList), intent(in) :: this
integer(kind=ik), intent(in) :: id
integer(kind=ik), intent(in) :: ind

Return Value character(len=:), allocatable


Module Subroutines

module subroutine initSpeciesList(this, jsonCont, mpiCont)

SpeciesList initialization from config.json.

Arguments

Type IntentOptional Attributes Name
class(SpeciesList), intent(inout) :: this
type(JSONController), intent(inout) :: jsonCont

JSONController used to get parameters from ./config.json

type(MPIController), intent(inout) :: mpiCont

MPIController used with JSONController