tblite
Light-weight tight-binding framework
Loading...
Searching...
No Matches
tblite_param_post_processing_localization::orbital_localization_record Type Reference

Record specifying the orbital localization post-processing. More...

Inheritance diagram for tblite_param_post_processing_localization::orbital_localization_record:
tblite_param_post_processing_type::post_processing_record tblite_param_serde::serde_record

Public Member Functions

procedure load_from_toml (self, table, error)
 Read parametrization data from TOML data structure.
procedure dump_to_toml (self, table, error)
 Write parametrization data to TOML data structure.
procedure populate_default_param (param, method)
 Populate parametrization record with default values.
Public Member Functions inherited from tblite_param_serde::serde_record
generic load (self, file, error)
 Reading of parametrization data.
generic load (self, unit, error)
 Reading of parametrization data.
generic load (self, table, error)
 Reading of parametrization data.
procedure(load_from_toml), deferred load_from_toml (self, table, error)
 Read parametrization data from TOML data structure.
generic dump (self, file, error)
 Writing of parametrization data.
generic dump (self, unit, error)
 Writing of parametrization data.
generic dump (self, table, error)
 Writing of parametrization data.
procedure(dump_to_toml), deferred dump_to_toml (self, table, error)
 Write parametrization data to TOML data structure.

Data Fields

character(len=:), allocatable method
 Name of the requested localization method.

Detailed Description

Record specifying the orbital localization post-processing.

Member Function/Subroutine Documentation

◆ dump_to_toml()

procedure tblite_param_post_processing_localization::orbital_localization_record::dump_to_toml ( class(orbital_localization_record), intent(in) self,
type(toml_table), intent(inout) table,
type(error_type), intent(out), allocatable error )

Write parametrization data to TOML data structure.

Parameters
[in]selfInstance of the parametrization data
[in,out]tableData structure
[out]errorError handling

◆ load_from_toml()

procedure tblite_param_post_processing_localization::orbital_localization_record::load_from_toml ( class(orbital_localization_record), intent(inout) self,
type(toml_table), intent(inout) table,
type(error_type), intent(out), allocatable error )

Read parametrization data from TOML data structure.

Parameters
[in,out]selfInstance of the parametrization data
[in,out]tableData structure
[out]errorError handling

◆ populate_default_param()

procedure tblite_param_post_processing_localization::orbital_localization_record::populate_default_param ( class(orbital_localization_record), intent(inout) param,
character(len=*), intent(in), optional method )

Populate parametrization record with default values.

Parameters
[in,out]paramOrbital localization post-processing record
[in]methodName of the localization method, defaults to Foster-Boys

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