ETS-Core  version:0.0.4-46-ge2d8
Core actors for the ETS-6
 All Classes Files Functions Variables Pages
Data Types | Public Member Functions | Public Attributes | List of all members
ids_species_compare Module Reference

This module include functions that compare speicies information in the IDSs. More...

Data Types

interface  same_species
 Return a boolean to say if the two input arguments "arg1" and "arg2" refers to the same species information. The information included are properties like nuclear charge, nuclear mass, ionic charge, multiplcity etc, while information that can be derived from the properties above, like name of a species, is not compared. More...
 

Public Member Functions

subroutine set_max_relative_delta (arg)
 
subroutine set_max_abs_delta (arg)
 
logical function same_ids_core_profile_ion (arg1, arg2)
 Compare species information between two arguments of type ids_core_profile_ions. More...
 
logical function same_ids_neutral_element_array (arg1, arg2)
 Compare species information between two arguments of ids_plasma_composition_neutral_element. More...
 
logical function same_ids_neutral_element (arg1, arg2)
 Compare species information between two arguments of ids_plasma_composition_neutral_element. More...
 
real(ids_real) function same_real (arg1, arg2)
 Compare two real number. Do not require an exact match, but within sqrt(machine-precision). More...
 
real(ids_real) function same_mass (arg1, arg2)
 Compare two atomic masses. Two mass may differ, but not by more than MAX_ABS_DELTA and the relative error may not be larger than MAX_RELATIVE_DELTA. More...
 

Public Attributes

real(ids_real), save max_relative_delta = 0.02
 
real(ids_real), save max_abs_delta = 0.499
 

Detailed Description

This module include functions that compare speicies information in the IDSs.

Author
Thomas Jonsson

Definition at line 5 of file ids_species_compare.f90.

Member Function/Subroutine Documentation

logical function ids_species_compare::same_ids_core_profile_ion ( type(ids_core_profile_ions)  arg1,
type(ids_core_profile_ions)  arg2 
)

Compare species information between two arguments of type ids_core_profile_ions.

Definition at line 41 of file ids_species_compare.f90.

References ids_species_compare::same_species::same_ids_neutral_element_array().

Here is the call graph for this function:

logical function ids_species_compare::same_ids_neutral_element ( type(ids_plasma_composition_neutral_element), intent(in)  arg1,
type(ids_plasma_composition_neutral_element), intent(in)  arg2 
)

Compare species information between two arguments of ids_plasma_composition_neutral_element.

Definition at line 77 of file ids_species_compare.f90.

References same_mass().

Here is the call graph for this function:

logical function ids_species_compare::same_ids_neutral_element_array ( type(ids_plasma_composition_neutral_element), dimension(:), intent(in), pointer  arg1,
type(ids_plasma_composition_neutral_element), dimension(:), intent(in), pointer  arg2 
)

Compare species information between two arguments of ids_plasma_composition_neutral_element.

Definition at line 53 of file ids_species_compare.f90.

References ids_species_compare::same_species::same_ids_neutral_element().

Here is the call graph for this function:

real(ids_real) function ids_species_compare::same_mass ( real(ids_real), intent(in)  arg1,
real(ids_real), intent(in)  arg2 
)

Compare two atomic masses. Two mass may differ, but not by more than MAX_ABS_DELTA and the relative error may not be larger than MAX_RELATIVE_DELTA.

Definition at line 102 of file ids_species_compare.f90.

Referenced by same_ids_neutral_element().

Here is the caller graph for this function:

real(ids_real) function ids_species_compare::same_real ( real(ids_real), intent(in)  arg1,
real(ids_real), intent(in)  arg2 
)

Compare two real number. Do not require an exact match, but within sqrt(machine-precision).

Definition at line 90 of file ids_species_compare.f90.

subroutine ids_species_compare::set_max_abs_delta ( real(ids_real)  arg)

Definition at line 34 of file ids_species_compare.f90.

subroutine ids_species_compare::set_max_relative_delta ( real(ids_real)  arg)

Definition at line 29 of file ids_species_compare.f90.

Member Data Documentation

real(ids_real), save ids_species_compare::max_abs_delta = 0.499

Definition at line 24 of file ids_species_compare.f90.

real(ids_real), save ids_species_compare::max_relative_delta = 0.02

Definition at line 23 of file ids_species_compare.f90.


The documentation for this module was generated from the following file: