species_factory_oct_m Module Reference

Data Types
type	species_factory_t

Functions/Subroutines
subroutine, public	species_factory_init (factory, namespace)
subroutine, public	species_factory_end (factory)
class(species_t) function, pointer	species_factory_create_from_input (factory, namespace, label, index)
	Reads the information (from the input file) about a species_t variable, initializing part of it (it has to be completed later with "species_build"). More...
class(species_t) function, pointer	read_from_block (factory, namespace, blk, row, label, index, read_data)
	Parses the species block for a given species. More...

Function/Subroutine Documentation

species_factory_init()

subroutine, public species_factory_oct_m::species_factory_init	(	class(species_factory_t), intent(inout)	factory,
		type(namespace_t), intent(in)	namespace
	)

Definition at line 158 of file species_factory.F90.

species_factory_end()

subroutine, public species_factory_oct_m::species_factory_end

(

class(species_factory_t), intent(inout)

factory

)

Definition at line 291 of file species_factory.F90.

species_factory_create_from_input()

class(species_t) function, pointer species_factory_oct_m::species_factory_create_from_input ( class(species_factory_t), intent(in)  factory, type(namespace_t), intent(in)  namespace, character(len=*), intent(in)  label, integer, intent(in)  index  )

private

Reads the information (from the input file) about a species_t variable, initializing part of it (it has to be completed later with "species_build").

This factory takes care of initializing the species with its label and index too

Parameters

[in]	factory	species factory
[in]	label	label of the species
[in]	index	index of the species

Returns

pointer to the newly created species

Definition at line 311 of file species_factory.F90.

read_from_block()

class(species_t) function, pointer species_factory_oct_m::read_from_block ( class(species_factory_t), intent(in)  factory, type(namespace_t), intent(in)  namespace, type(block_t), intent(in)  blk, integer, intent(in)  row, character(len=*), intent(in)  label, integer, intent(in)  index, integer, intent(out)  read_data  )

private

Parses the species block for a given species.

Parameters

[in]	blk	parsed block
[in]	row	specific row for the given species
[in]	label	label of the species
[in]	index	index of the species
[out]	read_data	return code after parsing

Returns

a pointer to the species

Definition at line 595 of file species_factory.F90.