MPI-SCATCI  2.0
An MPI version of SCATCI
basemanager_module Module Reference

Base manager type. More...

Data Types

type  basemanager
 This is a simple class to handle memory management tracking. More...
 

Functions/Subroutines

subroutine basemanager_ctor (this, total_memory)
 Type constructor. More...
 
subroutine init_memory (this, total_memory)
 Initialize memory. More...
 
subroutine track_memory (this, alloc_memory, error)
 Track memory. More...
 
subroutine free_memory (this, alloc_memory, error)
 Free memory. More...
 
integer(longint) function get_available_memory (this)
 Obtain available local memory. More...
 
integer(longint) function get_available_global_memory (this)
 Obtain available global memory. More...
 

Variables

type(basemanager), public memory_man
 

Detailed Description

Base manager type.

Authors
A Al-Refaie
Date
2017

This module contains the BaseManager class that is used to track all memory allocations within a single process, as of now it is fairly simple in implementation.

Note
16/01/2019 - Jakub Benda: Unifom coding style and expanded documentation.

Function/Subroutine Documentation

◆ basemanager_ctor()

subroutine basemanager_module::basemanager_ctor ( class(basemanager this,
integer(longint), intent(in)  total_memory 
)
private

Type constructor.

Authors
A Al-Refaie
Date
2017

Definition at line 71 of file BaseManager_module.f90.

Here is the caller graph for this function:

◆ free_memory()

subroutine basemanager_module::free_memory ( class(basemanager this,
integer(longint), intent(in)  alloc_memory,
integer, intent(out)  error 
)
private

Free memory.

Authors
A Al-Refaie
Date
2017

Definition at line 121 of file BaseManager_module.f90.

◆ get_available_global_memory()

integer(longint) function basemanager_module::get_available_global_memory ( class(basemanager this)
private

Obtain available global memory.

Authors
A Al-Refaie
Date
2017

Definition at line 154 of file BaseManager_module.f90.

◆ get_available_memory()

integer(longint) function basemanager_module::get_available_memory ( class(basemanager this)
private

Obtain available local memory.

Authors
A Al-Refaie
Date
2017

Definition at line 142 of file BaseManager_module.f90.

◆ init_memory()

subroutine basemanager_module::init_memory ( class(basemanager this,
integer(longint), intent(in)  total_memory 
)
private

Initialize memory.

Authors
A Al-Refaie
Date
2017

Definition at line 86 of file BaseManager_module.f90.

◆ track_memory()

subroutine basemanager_module::track_memory ( class(basemanager this,
integer(longint), intent(in)  alloc_memory,
integer, intent(out)  error 
)
private

Track memory.

Authors
A Al-Refaie
Date
2017

Definition at line 100 of file BaseManager_module.f90.

Variable Documentation

◆ memory_man

type(basemanager), public basemanager_module::memory_man

Definition at line 59 of file BaseManager_module.f90.