OpenCMISS-Iron Internal API Documentation
domain_mappings Module Reference

This module handles all domain mappings routines. More...

Functions/Subroutines

subroutine domain_mappings_adjacent_domain_finalise (ADJACENT_DOMAIN, ERR, ERROR,)
 Finalises the adjacent domain and deallocates all memory for a domain mapping. More...
 
subroutine domain_mappings_adjacent_domain_initialise (ADJACENT_DOMAIN, ERR, ERROR,)
 Initialise the adjacent domain for a domain mapping. More...
 
subroutine, public domain_mappings_global_to_local_get (DOMAIN_MAPPING, GLOBAL_NUMBER, LOCAL_EXISTS, LOCAL_NUMBER, ERR, ERROR,)
 Returns the local number, if it exists on the rank, for the specifed global number. More...
 
subroutine, public domain_mappings_local_from_global_calculate (DOMAIN_MAPPING, ERR, ERROR,)
 Calculates the domain mappings local map from a domain mappings global map. More...
 
subroutine, public domain_mappings_mapping_finalise (DOMAIN_MAPPING, ERR, ERROR,)
 Finalises the mapping for a domain mappings mapping and deallocates all memory. More...
 
subroutine domain_mappings_mapping_global_finalise (MAPPING_GLOBAL_MAP, ERR, ERROR,)
 Finalises the global mapping in the given domain mappings. More...
 
subroutine, public domain_mappings_mapping_global_initialise (MAPPING_GLOBAL_MAP, ERR, ERROR,)
 Finalises the global mapping in the given domain mappings. More...
 
subroutine, public domain_mappings_mapping_initialise (DOMAIN_MAPPING, NUMBER_OF_DOMAINS, ERR, ERROR,)
 Initialises the mapping for a domain mappings mapping. More...
 

Variables

integer(intg), parameter, public domain_local_internal =1
 The domain item is internal to the domain. More...
 
integer(intg), parameter, public domain_local_boundary =2
 The domain item is on the boundary of the domain. More...
 
integer(intg), parameter, public domain_local_ghost =3
 The domain item is ghosted from another domain. More...
 

Detailed Description

This module handles all domain mappings routines.

Function/Subroutine Documentation

subroutine domain_mappings::domain_mappings_adjacent_domain_finalise ( type(domain_adjacent_domain_type)  ADJACENT_DOMAIN,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the adjacent domain and deallocates all memory for a domain mapping.

Parameters
adjacent_domainThe adjacent domain to finalise.
[out]errThe error code
[out]errorThe error string

Definition at line 92 of file domain_mappings.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by domain_mappings_mapping_finalise().

subroutine domain_mappings::domain_mappings_adjacent_domain_initialise ( type(domain_adjacent_domain_type)  ADJACENT_DOMAIN,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Initialise the adjacent domain for a domain mapping.

Parameters
adjacent_domainThe adjacent domain to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 119 of file domain_mappings.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by domain_mappings_local_from_global_calculate().

subroutine, public domain_mappings::domain_mappings_global_to_local_get ( type(domain_mapping_type), pointer  DOMAIN_MAPPING,
integer(intg), intent(in)  GLOBAL_NUMBER,
logical, intent(out)  LOCAL_EXISTS,
integer(intg), intent(out)  LOCAL_NUMBER,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Returns the local number, if it exists on the rank, for the specifed global number.

Parameters
domain_mappingA pointer to the domain mapping to get the local number from
[in]global_numberThe global number to get the local number for
[out]local_existsOn exit, is .TRUE. if the specifed global number exists on the local rank, .FALSE. if not
[out]local_numberOn exit, the local number corresponding to the global number if it exists. If it doesn't exist then 0.
[out]errThe error code
[out]errorThe error string

Definition at line 144 of file domain_mappings.f90.

References comp_environment::computational_environment, base_routines::enters(), and base_routines::exits().

Referenced by finite_elasticity_routines::finiteelasticity_boundaryconditionsanalyticcalculate().

subroutine, public domain_mappings::domain_mappings_local_from_global_calculate ( type(domain_mapping_type), pointer  DOMAIN_MAPPING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
subroutine, public domain_mappings::domain_mappings_mapping_finalise ( type(domain_mapping_type), pointer  DOMAIN_MAPPING,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Finalises the mapping for a domain mappings mapping and deallocates all memory.

Parameters
domain_mappingA pointer to the domain mapping to finalise
[out]errThe error code
[out]errorThe error string

Definition at line 636 of file domain_mappings.f90.

References domain_mappings_adjacent_domain_finalise(), domain_mappings_mapping_global_finalise(), base_routines::enters(), and base_routines::exits().

Referenced by solver_mapping_routines::solver_mapping_finalise(), and solver_mapping_routines::solvermapping_solcoltoequationsmapsfinalise().

subroutine domain_mappings::domain_mappings_mapping_global_finalise ( type(domain_global_mapping_type)  MAPPING_GLOBAL_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)
private

Finalises the global mapping in the given domain mappings.

Parameters
mapping_global_mapThe domain global mapping to finalise
[out]errThe error code
[out]errorTh error string

Definition at line 680 of file domain_mappings.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by domain_mappings_mapping_finalise().

subroutine, public domain_mappings::domain_mappings_mapping_global_initialise ( type(domain_global_mapping_type)  MAPPING_GLOBAL_MAP,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Finalises the global mapping in the given domain mappings.

Parameters
mapping_global_mapThe domain global mapping to initialise
[out]errThe error code
[out]errorThe error string

Definition at line 706 of file domain_mappings.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by solver_mapping_routines::solver_mapping_calculate().

subroutine, public domain_mappings::domain_mappings_mapping_initialise ( type(domain_mapping_type), pointer  DOMAIN_MAPPING,
integer(intg), intent(in)  NUMBER_OF_DOMAINS,
integer(intg), intent(out)  ERR,
type(varying_string), intent(out)  ERROR 
)

Initialises the mapping for a domain mappings mapping.

Parameters
domain_mappingA pointer to the domain mapping to initialise the mappings for
[in]number_of_domainsThe number of domains
[out]errThe error code
[out]errorThe error string

Definition at line 730 of file domain_mappings.f90.

References base_routines::enters(), and base_routines::exits().

Referenced by solver_mapping_routines::solver_mapping_calculate().