Octopus
Public Attributes | Private Member Functions | Private Attributes | List of all members
restart_oct_m::restart_basic_t Type Reference

restart_basic_t stores the basic information about a restart object. More...

Detailed Description

restart_basic_t stores the basic information about a restart object.

This includes the namespace, the data type, the type of restart (dump or load), the directory where the restart data is stored, the current directory where the restart data is being loaded from or dumped to, the base directory for the restart data, the flags that modify the way the data is read or written, and the mpi group used for some operations.

Note
The restart_basic_t type can be used for restart data, not depending on the mesh.

Definition at line 194 of file restart.F90.

Inheritance diagram for restart_oct_m::restart_basic_t:
Inheritance graph

Public Attributes

type(namespace_t), pointer, public namespace
 namespace depending on system to modify path More...
 
character(len=max_path_len), public basedir
 base directory for restart data. More...
 
type(mpi_grp_t), public mpi_grp
 Some operations require an mpi group to be used. More...
 
logical, public grid_changed = .false.
 The restart data was written on a different mesh. More...
 

Private Member Functions

procedure, private restart_basic_init
 
generic init => restart_basic_init
 
procedure end => restart_basic_end
 
procedure open => restart_basic_open
 
procedure close => restart_basic_close
 
procedure open_dir => restart_basic_open_dir
 
procedure close_dir => restart_basic_close_dir
 
procedure mkdir => restart_basic_mkdir
 
procedure dir => restart_basic_dir
 
procedure rm => restart_basic_rm
 
procedure read => restart_basic_read
 
procedure write => restart_basic_write
 
procedure get_data_type => restart_basic_get_data_type
 
procedure get_info => restart_basic_get_info
 
procedure do_i_write => restart_basic_do_i_write
 
procedure skip => restart_basic_skip
 
procedure has_flag => restart_basic_has_flag
 

Private Attributes

integer data_type = RESTART_UNDEFINED
 Type of information that the restart is supposed to read/write: GS,TD,etc. More...
 
integer type = RESTART_UNDEFINED
 Restart type: RESTART_TYPE_DUMP or RESTART_TYPE_LOAD. More...
 
logical skip_
 If set to .true., no restart information should be loaded or dumped. More...
 
character(len=max_path_len) dir_
 Directory where the restart information for given data type is stored. More...
 
character(len=max_path_len) pwd
 The current directory where the restart information is being loaded. More...
 
integer flags
 
logical initialized = .false.
 

Member Function/Subroutine Documentation

◆ restart_basic_init()

procedure, private restart_oct_m::restart_basic_t::restart_basic_init
private

Definition at line 212 of file restart.F90.

◆ init()

generic restart_oct_m::restart_basic_t::init
private

Definition at line 213 of file restart.F90.

◆ end()

procedure restart_oct_m::restart_basic_t::end
private

Definition at line 214 of file restart.F90.

◆ open()

procedure restart_oct_m::restart_basic_t::open
private

Definition at line 215 of file restart.F90.

◆ close()

procedure restart_oct_m::restart_basic_t::close
private

Definition at line 216 of file restart.F90.

◆ open_dir()

procedure restart_oct_m::restart_basic_t::open_dir
private

Definition at line 217 of file restart.F90.

◆ close_dir()

procedure restart_oct_m::restart_basic_t::close_dir
private

Definition at line 218 of file restart.F90.

◆ mkdir()

procedure restart_oct_m::restart_basic_t::mkdir
private

Definition at line 219 of file restart.F90.

◆ dir()

procedure restart_oct_m::restart_basic_t::dir
private

Definition at line 220 of file restart.F90.

◆ rm()

procedure restart_oct_m::restart_basic_t::rm
private

Definition at line 221 of file restart.F90.

◆ read()

procedure restart_oct_m::restart_basic_t::read
private

Definition at line 222 of file restart.F90.

◆ write()

procedure restart_oct_m::restart_basic_t::write
private

Definition at line 223 of file restart.F90.

◆ get_data_type()

procedure restart_oct_m::restart_basic_t::get_data_type
private

Definition at line 224 of file restart.F90.

◆ get_info()

procedure restart_oct_m::restart_basic_t::get_info
private

Definition at line 225 of file restart.F90.

◆ do_i_write()

procedure restart_oct_m::restart_basic_t::do_i_write
private

Definition at line 226 of file restart.F90.

◆ skip()

procedure restart_oct_m::restart_basic_t::skip
private

Definition at line 227 of file restart.F90.

◆ has_flag()

procedure restart_oct_m::restart_basic_t::has_flag
private

Definition at line 228 of file restart.F90.

Member Data Documentation

◆ namespace

type(namespace_t), pointer, public restart_oct_m::restart_basic_t::namespace

namespace depending on system to modify path

Definition at line 196 of file restart.F90.

◆ data_type

integer restart_oct_m::restart_basic_t::data_type = RESTART_UNDEFINED
private

Type of information that the restart is supposed to read/write: GS,TD,etc.

Definition at line 197 of file restart.F90.

◆ type

integer restart_oct_m::restart_basic_t::type = RESTART_UNDEFINED
private

Restart type: RESTART_TYPE_DUMP or RESTART_TYPE_LOAD.

Definition at line 198 of file restart.F90.

◆ skip_

logical restart_oct_m::restart_basic_t::skip_
private

If set to .true., no restart information should be loaded or dumped.

Definition at line 199 of file restart.F90.

◆ dir_

character(len=max_path_len) restart_oct_m::restart_basic_t::dir_
private

Directory where the restart information for given data type is stored.

Definition at line 200 of file restart.F90.

◆ pwd

character(len=max_path_len) restart_oct_m::restart_basic_t::pwd
private

The current directory where the restart information is being loaded.

Definition at line 201 of file restart.F90.

◆ basedir

character(len=max_path_len), public restart_oct_m::restart_basic_t::basedir

base directory for restart data.

Definition at line 204 of file restart.F90.

◆ flags

integer restart_oct_m::restart_basic_t::flags
private

Definition at line 205 of file restart.F90.

◆ mpi_grp

type(mpi_grp_t), public restart_oct_m::restart_basic_t::mpi_grp

Some operations require an mpi group to be used.

Definition at line 206 of file restart.F90.

◆ initialized

logical restart_oct_m::restart_basic_t::initialized = .false.
private

Definition at line 207 of file restart.F90.

◆ grid_changed

logical, public restart_oct_m::restart_basic_t::grid_changed = .false.

The restart data was written on a different mesh.

Definition at line 208 of file restart.F90.

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