FE-Project
Loading...
Searching...
No Matches
scale_file_restart_meshfield::file_restart_meshfield_component Type Reference

Derived type to manage restart file with each component. More...

Public Member Functions

procedure init1 (this, comp_name, var_num, dim_name_postfix, mesh1d, mesh2d, meshcubedsphere2d, mesh3d, meshcubedsphere3d)
 Initialize an object to manage restart file with each component, and register the component to the main restart file.
procedure init2 (this, comp_name, in_basename, in_postfix_timelabel, out_basename, out_postfix_timelabel, out_dtype, out_title, var_num, dim_name_postfix, mesh1d, mesh2d, meshcubedsphere2d, mesh3d, meshcubedsphere3d)
 Initialize an object to manage restart file with each component. Restart data for this component are individually outputted to a separate file, not to the main restart file.
generic init (this, comp_name, var_num, dim_name_postfix, mesh1d, mesh2d, meshcubedsphere2d, mesh3d, meshcubedsphere3d)
 Initialize an object to manage restart file with each component, and register the component to the main restart file.
generic init (this, comp_name, in_basename, in_postfix_timelabel, out_basename, out_postfix_timelabel, out_dtype, out_title, var_num, dim_name_postfix, mesh1d, mesh2d, meshcubedsphere2d, mesh3d, meshcubedsphere3d)
 Initialize an object to manage restart file with each component. Restart data for this component are individually outputted to a separate file, not to the main restart file.
procedure open (this)
 Open a restart file.
procedure file_restart_meshfield_component_create (this)
 Create a restart file.
generic create (this)
 Create a restart file.
procedure file_restart_meshfield_component_def_var (this, field, desc, vid, dim_type_id)
 Define a variable in the restart file.
generic def_var (this, field, desc, vid, dim_type_id)
 Define a variable in the restart file.
procedure end_def (this)
 Finalize the definition of variables in the restart file.
procedure file_restart_meshfield_component_write_var2d (this, vid, field2d)
 Write a 2D variable to the restart file.
procedure file_restart_meshfield_component_write_var3d (this, vid, field3d)
 Write a 3D variable to the restart file.
generic write_var (this, vid, field2d)
 Write a 2D variable to the restart file.
generic write_var (this, vid, field3d)
 Write a 3D variable to the restart file.
procedure close (this)
 Close a restart file.
procedure file_restart_meshfield_component_read_var2d (this, dim_typeid, varname, field2d, step, allow_missing)
 Read a 2D variable from the restart file.
procedure file_restart_meshfield_component_read_var3d (this, dim_typeid, varname, field3d, step, allow_missing)
 Read a 3D variable from the restart file.
generic read_var (this, dim_typeid, varname, field2d, step, allow_missing)
 Read a 2D variable from the restart file.
generic read_var (this, dim_typeid, varname, field3d, step, allow_missing)
 Read a 3D variable from the restart file.
procedure final (this)
 Finalize an object to manage restart file with each component.

Public Attributes

integer registered_comp_id
 ID of the component registered for restart file.

Detailed Description

Derived type to manage restart file with each component.

Definition at line 85 of file scale_file_restart_meshfield.F90.

Member Function/Subroutine Documentation

◆ init1()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::init1 ( class(file_restart_meshfield_component), intent(inout) this,
character(*), intent(in) comp_name,
integer, intent(in) var_num,
character(len=*), intent(in), optional dim_name_postfix,
class(meshbase1d), intent(in), optional, target mesh1d,
class(meshrectdom2d), intent(in), optional, target mesh2d,
class(meshcubedspheredom2d), intent(in), optional, target meshcubedsphere2d,
class(meshcubedom3d), intent(in), optional, target mesh3d,
class(meshcubedspheredom3d), intent(in), optional, target meshcubedsphere3d )

Initialize an object to manage restart file with each component, and register the component to the main restart file.

Definition at line 88 of file scale_file_restart_meshfield.F90.

◆ init2()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::init2 ( class(file_restart_meshfield_component), intent(inout) this,
character(*), intent(in) comp_name,
character(*), intent(in) in_basename,
logical, intent(in) in_postfix_timelabel,
character(*), intent(in) out_basename,
logical, intent(in) out_postfix_timelabel,
character(*), intent(in) out_dtype,
character(*), intent(in) out_title,
integer, intent(in) var_num,
character(len=*), intent(in) dim_name_postfix,
class(meshbase1d), intent(in), optional, target mesh1d,
class(meshrectdom2d), intent(in), optional, target mesh2d,
class(meshcubedspheredom2d), intent(in), optional, target meshcubedsphere2d,
class(meshcubedom3d), intent(in), optional, target mesh3d,
class(meshcubedspheredom3d), intent(in), optional, target meshcubedsphere3d )

Initialize an object to manage restart file with each component. Restart data for this component are individually outputted to a separate file, not to the main restart file.

Definition at line 89 of file scale_file_restart_meshfield.F90.

◆ init() [1/2]

generic scale_file_restart_meshfield::file_restart_meshfield_component::init ( class(file_restart_meshfield_component), intent(inout) this,
character(*), intent(in) comp_name,
integer, intent(in) var_num,
character(len=*), intent(in), optional dim_name_postfix,
class(meshbase1d), intent(in), optional, target mesh1d,
class(meshrectdom2d), intent(in), optional, target mesh2d,
class(meshcubedspheredom2d), intent(in), optional, target meshcubedsphere2d,
class(meshcubedom3d), intent(in), optional, target mesh3d,
class(meshcubedspheredom3d), intent(in), optional, target meshcubedsphere3d )

Initialize an object to manage restart file with each component, and register the component to the main restart file.

Definition at line 90 of file scale_file_restart_meshfield.F90.

◆ init() [2/2]

generic scale_file_restart_meshfield::file_restart_meshfield_component::init ( class(file_restart_meshfield_component), intent(inout) this,
character(*), intent(in) comp_name,
character(*), intent(in) in_basename,
logical, intent(in) in_postfix_timelabel,
character(*), intent(in) out_basename,
logical, intent(in) out_postfix_timelabel,
character(*), intent(in) out_dtype,
character(*), intent(in) out_title,
integer, intent(in) var_num,
character(len=*), intent(in) dim_name_postfix,
class(meshbase1d), intent(in), optional, target mesh1d,
class(meshrectdom2d), intent(in), optional, target mesh2d,
class(meshcubedspheredom2d), intent(in), optional, target meshcubedsphere2d,
class(meshcubedom3d), intent(in), optional, target mesh3d,
class(meshcubedspheredom3d), intent(in), optional, target meshcubedsphere3d )

Initialize an object to manage restart file with each component. Restart data for this component are individually outputted to a separate file, not to the main restart file.

Definition at line 90 of file scale_file_restart_meshfield.F90.

◆ open()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::open ( class(file_restart_meshfield_component), intent(inout) this)

Open a restart file.

Definition at line 91 of file scale_file_restart_meshfield.F90.

◆ file_restart_meshfield_component_create()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::file_restart_meshfield_component_create ( class(file_restart_meshfield_component), intent(inout) this)

Create a restart file.

Definition at line 92 of file scale_file_restart_meshfield.F90.

◆ create()

generic scale_file_restart_meshfield::file_restart_meshfield_component::create ( class(file_restart_meshfield_component), intent(inout) this)

Create a restart file.

Definition at line 93 of file scale_file_restart_meshfield.F90.

◆ file_restart_meshfield_component_def_var()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::file_restart_meshfield_component_def_var ( class(file_restart_meshfield_component), intent(inout) this,
class(meshfieldbase), intent(in) field,
character(len=*), intent(in) desc,
integer, intent(in) vid,
integer, intent(in) dim_type_id )

Define a variable in the restart file.

Definition at line 94 of file scale_file_restart_meshfield.F90.

◆ def_var()

generic scale_file_restart_meshfield::file_restart_meshfield_component::def_var ( class(file_restart_meshfield_component), intent(inout) this,
class(meshfieldbase), intent(in) field,
character(len=*), intent(in) desc,
integer, intent(in) vid,
integer, intent(in) dim_type_id )

Define a variable in the restart file.

Definition at line 95 of file scale_file_restart_meshfield.F90.

◆ end_def()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::end_def ( class(file_restart_meshfield_component), intent(inout) this)

Finalize the definition of variables in the restart file.

Definition at line 96 of file scale_file_restart_meshfield.F90.

◆ file_restart_meshfield_component_write_var2d()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::file_restart_meshfield_component_write_var2d ( class(file_restart_meshfield_component), intent(inout) this,
integer, intent(in) vid,
class(meshfield2d), intent(in) field2d )

Write a 2D variable to the restart file.

Definition at line 97 of file scale_file_restart_meshfield.F90.

◆ file_restart_meshfield_component_write_var3d()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::file_restart_meshfield_component_write_var3d ( class(file_restart_meshfield_component), intent(inout) this,
integer, intent(in) vid,
class(meshfield3d), intent(in) field3d )

Write a 3D variable to the restart file.

Definition at line 98 of file scale_file_restart_meshfield.F90.

◆ write_var() [1/2]

generic scale_file_restart_meshfield::file_restart_meshfield_component::write_var ( class(file_restart_meshfield_component), intent(inout) this,
integer, intent(in) vid,
class(meshfield2d), intent(in) field2d )

Write a 2D variable to the restart file.

Definition at line 99 of file scale_file_restart_meshfield.F90.

◆ write_var() [2/2]

generic scale_file_restart_meshfield::file_restart_meshfield_component::write_var ( class(file_restart_meshfield_component), intent(inout) this,
integer, intent(in) vid,
class(meshfield3d), intent(in) field3d )

Write a 3D variable to the restart file.

Definition at line 99 of file scale_file_restart_meshfield.F90.

◆ close()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::close ( class(file_restart_meshfield_component), intent(inout) this)

Close a restart file.

Definition at line 102 of file scale_file_restart_meshfield.F90.

◆ file_restart_meshfield_component_read_var2d()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::file_restart_meshfield_component_read_var2d ( class(file_restart_meshfield_component), intent(inout) this,
integer, intent(in) dim_typeid,
character(*), intent(in) varname,
class(meshfield2d), intent(inout) field2d,
integer, intent(in), optional step,
logical, intent(in), optional allow_missing )

Read a 2D variable from the restart file.

Definition at line 103 of file scale_file_restart_meshfield.F90.

◆ file_restart_meshfield_component_read_var3d()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::file_restart_meshfield_component_read_var3d ( class(file_restart_meshfield_component), intent(inout) this,
integer, intent(in) dim_typeid,
character(*), intent(in) varname,
class(meshfield3d), intent(inout) field3d,
integer, intent(in), optional step,
logical, intent(in), optional allow_missing )

Read a 3D variable from the restart file.

Definition at line 104 of file scale_file_restart_meshfield.F90.

◆ read_var() [1/2]

generic scale_file_restart_meshfield::file_restart_meshfield_component::read_var ( class(file_restart_meshfield_component), intent(inout) this,
integer, intent(in) dim_typeid,
character(*), intent(in) varname,
class(meshfield2d), intent(inout) field2d,
integer, intent(in), optional step,
logical, intent(in), optional allow_missing )

Read a 2D variable from the restart file.

Definition at line 105 of file scale_file_restart_meshfield.F90.

◆ read_var() [2/2]

generic scale_file_restart_meshfield::file_restart_meshfield_component::read_var ( class(file_restart_meshfield_component), intent(inout) this,
integer, intent(in) dim_typeid,
character(*), intent(in) varname,
class(meshfield3d), intent(inout) field3d,
integer, intent(in), optional step,
logical, intent(in), optional allow_missing )

Read a 3D variable from the restart file.

Definition at line 105 of file scale_file_restart_meshfield.F90.

◆ final()

procedure scale_file_restart_meshfield::file_restart_meshfield_component::final ( class(file_restart_meshfield_component), intent(inout) this)

Finalize an object to manage restart file with each component.

Definition at line 108 of file scale_file_restart_meshfield.F90.

References scale_file_restart_meshfield::file_restart_meshfield_finalize(), and scale_file_restart_meshfield::file_restart_meshfield_setup().

Member Data Documentation

◆ registered_comp_id

integer scale_file_restart_meshfield::file_restart_meshfield_component::registered_comp_id

ID of the component registered for restart file.

Definition at line 86 of file scale_file_restart_meshfield.F90.

86 integer :: registered_comp_id !< ID of the component registered for restart file

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