DAMASK_EICMD/src/config.f90

!--------------------------------------------------------------------------------------------------
!> @author Martin Diehl, Max-Planck-Institut für Eisenforschung GmbH
!> @brief Read in the configuration of material, numerics, and debug from their respective file
!--------------------------------------------------------------------------------------------------
module config
  use IO
  use YAML_parse
  use YAML_types
  use result
  use parallelization

  implicit none(type,external)
  private

  type(tDict), pointer, public :: &
    config_material, &
    config_numerics, &
    config_debug

  public :: &
    config_init, &
    config_deallocate

contains

!--------------------------------------------------------------------------------------------------
!> @brief Real *.yaml configuration files.
!--------------------------------------------------------------------------------------------------
subroutine config_init()

  print'(/,1x,a)', '<<<+-  config init  -+>>>'; flush(IO_STDOUT)

  call parse_material()
  call parse_numerics()
  call parse_debug()

end subroutine config_init


!--------------------------------------------------------------------------------------------------
!> @brief Read material.yaml.
!--------------------------------------------------------------------------------------------------
subroutine parse_material()

  logical :: fileExists
  character(len=:), allocatable :: fileContent


  inquire(file='material.yaml',exist=fileExists)
  if (.not. fileExists) call IO_error(100,ext_msg='material.yaml')

  if (worldrank == 0) then
    print'(/,1x,a)', 'reading material.yaml'; flush(IO_STDOUT)
    fileContent = IO_read('material.yaml')
    call result_openJobFile(parallel=.false.)
    call result_writeDataset_str(fileContent,'setup','material.yaml','main configuration')
    call result_closeJobFile
  end if
  call parallelization_bcast_str(fileContent)

  config_material => YAML_parse_str_asDict(fileContent)

end subroutine parse_material


!--------------------------------------------------------------------------------------------------
!> @brief Read numerics.yaml.
!--------------------------------------------------------------------------------------------------
subroutine parse_numerics()

  logical :: fileExists
  character(len=:), allocatable :: fileContent


  config_numerics => emptyDict

  inquire(file='numerics.yaml', exist=fileExists)
  if (fileExists) then

    if (worldrank == 0) then
      print'(1x,a)', 'reading numerics.yaml'; flush(IO_STDOUT)
      fileContent = IO_read('numerics.yaml')
      if (len(fileContent) > 0) then
        call result_openJobFile(parallel=.false.)
        call result_writeDataset_str(fileContent,'setup','numerics.yaml','numerics configuration')
        call result_closeJobFile
      end if
    end if
    call parallelization_bcast_str(fileContent)

    config_numerics => YAML_parse_str_asDict(fileContent)

  end if

end subroutine parse_numerics


!--------------------------------------------------------------------------------------------------
!> @brief Read debug.yaml.
!--------------------------------------------------------------------------------------------------
subroutine parse_debug()

  logical :: fileExists
  character(len=:), allocatable :: fileContent


  config_debug => emptyDict

  inquire(file='debug.yaml', exist=fileExists)
  if (fileExists) then

    if (worldrank == 0) then
      print'(1x,a)', 'reading debug.yaml'; flush(IO_STDOUT)
      fileContent = IO_read('debug.yaml')
      if (len(fileContent) > 0) then
        call result_openJobFile(parallel=.false.)
        call result_writeDataset_str(fileContent,'setup','debug.yaml','debug configuration')
        call result_closeJobFile
      end if
    end if
    call parallelization_bcast_str(fileContent)

    config_debug => YAML_parse_str_asDict(fileContent)

  end if

end subroutine parse_debug


!--------------------------------------------------------------------------------------------------
!> @brief Deallocate config_material.
!ToDo: deallocation of numerics and debug (optional)
!--------------------------------------------------------------------------------------------------
subroutine config_deallocate

  deallocate(config_material)

end subroutine config_deallocate

end module config
read file only once 2020-01-27 00:26:30 +05:30			`!--------------------------------------------------------------------------------------------------`
list does tokenizing automatically 2018-06-10 14:37:17 +05:30			`!> @author Martin Diehl, Max-Planck-Institut für Eisenforschung GmbH`
remove unused CLI module inclusion 2022-04-26 21:49:13 +05:30			`!> @brief Read in the configuration of material, numerics, and debug from their respective file`
list does tokenizing automatically 2018-06-10 14:37:17 +05:30			`!--------------------------------------------------------------------------------------------------`
more general name (should include parsing of debug and numerics) 2018-06-14 10:09:49 +05:30			`module config`
don't clutter the code with useless stuff we only need to be more strict about prefixing functions/subroutines/variables to see in which module they reside 2019-05-17 02:26:48 +05:30			`use IO`
Read numerics.yaml once 2020-06-16 22:17:19 +05:30			`use YAML_parse`
			`use YAML_types`
Resolve "naming for classes" 2023-01-19 22:07:45 +05:30			`use result`
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`use parallelization`
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30
[skip sc] enforce interfaces (quick fix: declare as external) 2022-06-22 02:16:54 +05:30			`implicit none(type,external)`
one implicit none is enough 2019-05-15 02:42:32 +05:30			`private`
don't clutter the code with useless stuff we only need to be more strict about prefixing functions/subroutines/variables to see in which module they reside 2019-05-17 02:26:48 +05:30
Re-written YAML types Strict typing for YAML New access pattern requires to specify the expected type, i.e. 'scalar', 'list', or 'dict'. This ensures that the node offers the expected functionality instead of polluting 'tNode' with dummy functions which throw error messages if not overwritten. The restructuring of the code allows to hierarchically construct methods without much code duplication. Some aspects of the error messaging system have been improved. 2022-10-25 21:39:36 +05:30			`type(tDict), pointer, public :: &`
prefix should be name of the module poor substitute for namespace 2020-09-13 14:09:17 +05:30			`config_material, &`
			`config_numerics, &`
			`config_debug`
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30
use list from separate module 2019-03-29 13:04:44 +05:30			`public :: &`
			`config_init, &`
			`config_deallocate`
most IO related variables not needed any more in material 2018-06-10 22:08:31 +05:30
migrating reading in of material.config to own module 2018-06-09 00:31:58 +05:30			`contains`

possibility to deallocate material.config parts 2018-06-27 00:00:41 +05:30			`!--------------------------------------------------------------------------------------------------`
polishing 2020-09-14 00:58:53 +05:30			`!> @brief Real *.yaml configuration files.`
possibility to deallocate material.config parts 2018-06-27 00:00:41 +05:30			`!--------------------------------------------------------------------------------------------------`
systematic naming scheme 2022-04-24 08:13:44 +05:30			`subroutine config_init()`
don't clutter the code with useless stuff we only need to be more strict about prefixing functions/subroutines/variables to see in which module they reside 2019-05-17 02:26:48 +05:30
consistent indentation and line-spacings in reporting 2021-11-15 23:05:44 +05:30			`print'(/,1x,a)', '<<<+- config init -+>>>'; flush(IO_STDOUT)`
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30
systematic naming scheme 2022-04-24 08:13:44 +05:30			`call parse_material()`
			`call parse_numerics()`
			`call parse_debug()`
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30
			`end subroutine config_init`

use list from separate module 2019-03-29 13:04:44 +05:30
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`!--------------------------------------------------------------------------------------------------`
systematic naming scheme 2022-04-24 08:13:44 +05:30			`!> @brief Read material.yaml.`
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`!--------------------------------------------------------------------------------------------------`
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`subroutine parse_material()`
use list from separate module 2019-03-29 13:04:44 +05:30
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`logical :: fileExists`
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`character(len=:), allocatable :: fileContent`
jobname.yaml not supported anymore 2021-02-13 04:05:06 +05:30

			`inquire(file='material.yaml',exist=fileExists)`
consistent indentation and line-spacings in reporting 2021-11-15 23:05:44 +05:30			`if (.not. fileExists) call IO_error(100,ext_msg='material.yaml')`
read file only once (per process) 2021-07-27 12:05:52 +05:30
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`if (worldrank == 0) then`
consistent indentation and line-spacings in reporting 2021-11-15 23:05:44 +05:30			`print'(/,1x,a)', 'reading material.yaml'; flush(IO_STDOUT)`
only rank 0 reads file for MPI 2021-07-27 12:24:17 +05:30			`fileContent = IO_read('material.yaml')`
Resolve "naming for classes" 2023-01-19 22:07:45 +05:30			`call result_openJobFile(parallel=.false.)`
			`call result_writeDataset_str(fileContent,'setup','material.yaml','main configuration')`
			`call result_closeJobFile`
consistent indentation and line-spacings in reporting 2021-11-15 23:05:44 +05:30			`end if`
only rank 0 reads file for MPI 2021-07-27 12:24:17 +05:30			`call parallelization_bcast_str(fileContent)`
read file only once (per process) 2021-07-27 12:05:52 +05:30
Re-written YAML types Strict typing for YAML New access pattern requires to specify the expected type, i.e. 'scalar', 'list', or 'dict'. This ensures that the node offers the expected functionality instead of polluting 'tNode' with dummy functions which throw error messages if not overwritten. The restructuring of the code allows to hierarchically construct methods without much code duplication. Some aspects of the error messaging system have been improved. 2022-10-25 21:39:36 +05:30			`config_material => YAML_parse_str_asDict(fileContent)`
reading in done by one function 2018-06-09 17:18:37 +05:30
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`end subroutine parse_material`
clearer structure 2019-03-13 02:18:33 +05:30

			`!--------------------------------------------------------------------------------------------------`
polishing 2020-09-14 00:58:53 +05:30			`!> @brief Read numerics.yaml.`
clearer structure 2019-03-13 02:18:33 +05:30			`!--------------------------------------------------------------------------------------------------`
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`subroutine parse_numerics()`
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`logical :: fileExists`
			`character(len=:), allocatable :: fileContent`
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30
jobname.yaml not supported anymore 2021-02-13 04:05:06 +05:30
prefix should be name of the module poor substitute for namespace 2020-09-13 14:09:17 +05:30			`config_numerics => emptyDict`
read file only once (per process) 2021-07-27 12:05:52 +05:30
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`inquire(file='numerics.yaml', exist=fileExists)`
			`if (fileExists) then`
read file only once (per process) 2021-07-27 12:05:52 +05:30
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`if (worldrank == 0) then`
consistent indentation and line-spacings in reporting 2021-11-15 23:05:44 +05:30			`print'(1x,a)', 'reading numerics.yaml'; flush(IO_STDOUT)`
only rank 0 reads file for MPI 2021-07-27 12:24:17 +05:30			`fileContent = IO_read('numerics.yaml')`
avoid issues with empty files optional files (numerics.yaml, debug.yaml) can be empty 2021-08-14 23:31:25 +05:30			`if (len(fileContent) > 0) then`
Resolve "naming for classes" 2023-01-19 22:07:45 +05:30			`call result_openJobFile(parallel=.false.)`
			`call result_writeDataset_str(fileContent,'setup','numerics.yaml','numerics configuration')`
			`call result_closeJobFile`
consistent indentation and line-spacings in reporting 2021-11-15 23:05:44 +05:30			`end if`
			`end if`
only rank 0 reads file for MPI 2021-07-27 12:24:17 +05:30			`call parallelization_bcast_str(fileContent)`
read file only once (per process) 2021-07-27 12:05:52 +05:30
Re-written YAML types Strict typing for YAML New access pattern requires to specify the expected type, i.e. 'scalar', 'list', or 'dict'. This ensures that the node offers the expected functionality instead of polluting 'tNode' with dummy functions which throw error messages if not overwritten. The restructuring of the code allows to hierarchically construct methods without much code duplication. Some aspects of the error messaging system have been improved. 2022-10-25 21:39:36 +05:30			`config_numerics => YAML_parse_str_asDict(fileContent)`
read file only once (per process) 2021-07-27 12:05:52 +05:30
consistent indentation and line-spacings in reporting 2021-11-15 23:05:44 +05:30			`end if`
clearer structure 2019-03-13 02:18:33 +05:30
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`end subroutine parse_numerics`
clearer structure 2019-03-13 02:18:33 +05:30
migrating reading in of material.config to own module 2018-06-09 00:31:58 +05:30
polished for merge access to array(n+m:) is safe for array of size n with m>1 2018-08-04 23:09:50 +05:30			`!--------------------------------------------------------------------------------------------------`
polishing 2020-09-14 00:58:53 +05:30			`!> @brief Read debug.yaml.`
polished for merge access to array(n+m:) is safe for array of size n with m>1 2018-08-04 23:09:50 +05:30			`!--------------------------------------------------------------------------------------------------`
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`subroutine parse_debug()`
possibility to deallocate material.config parts 2018-06-27 00:00:41 +05:30
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`logical :: fileExists`
			`character(len=:), allocatable :: fileContent`
using final seems to be the better approach http://www.training.prace-ri.eu/uploads/tx_pracetmo/AdvFTN_handout.pdf still needs in-depth analysis, even though I cannot reproduce 'terminally ill' 2018-08-21 11:44:59 +05:30
jobname.yaml not supported anymore 2021-02-13 04:05:06 +05:30
prefix should be name of the module poor substitute for namespace 2020-09-13 14:09:17 +05:30			`config_debug => emptyDict`
read file only once (per process) 2021-07-27 12:05:52 +05:30
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`inquire(file='debug.yaml', exist=fileExists)`
			`if (fileExists) then`
read file only once (per process) 2021-07-27 12:05:52 +05:30
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`if (worldrank == 0) then`
consistent indentation and line-spacings in reporting 2021-11-15 23:05:44 +05:30			`print'(1x,a)', 'reading debug.yaml'; flush(IO_STDOUT)`
only rank 0 reads file for MPI 2021-07-27 12:24:17 +05:30			`fileContent = IO_read('debug.yaml')`
avoid issues with empty files optional files (numerics.yaml, debug.yaml) can be empty 2021-08-14 23:31:25 +05:30			`if (len(fileContent) > 0) then`
Resolve "naming for classes" 2023-01-19 22:07:45 +05:30			`call result_openJobFile(parallel=.false.)`
			`call result_writeDataset_str(fileContent,'setup','debug.yaml','debug configuration')`
			`call result_closeJobFile`
consistent indentation and line-spacings in reporting 2021-11-15 23:05:44 +05:30			`end if`
			`end if`
only rank 0 reads file for MPI 2021-07-27 12:24:17 +05:30			`call parallelization_bcast_str(fileContent)`
read file only once (per process) 2021-07-27 12:05:52 +05:30
Re-written YAML types Strict typing for YAML New access pattern requires to specify the expected type, i.e. 'scalar', 'list', or 'dict'. This ensures that the node offers the expected functionality instead of polluting 'tNode' with dummy functions which throw error messages if not overwritten. The restructuring of the code allows to hierarchically construct methods without much code duplication. Some aspects of the error messaging system have been improved. 2022-10-25 21:39:36 +05:30			`config_debug => YAML_parse_str_asDict(fileContent)`
read file only once (per process) 2021-07-27 12:05:52 +05:30
consistent indentation and line-spacings in reporting 2021-11-15 23:05:44 +05:30			`end if`
using final seems to be the better approach http://www.training.prace-ri.eu/uploads/tx_pracetmo/AdvFTN_handout.pdf still needs in-depth analysis, even though I cannot reproduce 'terminally ill' 2018-08-21 11:44:59 +05:30
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`end subroutine parse_debug`
using final seems to be the better approach http://www.training.prace-ri.eu/uploads/tx_pracetmo/AdvFTN_handout.pdf still needs in-depth analysis, even though I cannot reproduce 'terminally ill' 2018-08-21 11:44:59 +05:30

Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`!--------------------------------------------------------------------------------------------------`
polishing 2020-09-14 00:58:53 +05:30			`!> @brief Deallocate config_material.`
cleaning 2021-05-23 03:40:46 +05:30			`!ToDo: deallocation of numerics and debug (optional)`
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`!--------------------------------------------------------------------------------------------------`
			`subroutine config_deallocate`
possibility to deallocate material.config parts 2018-06-27 00:00:41 +05:30
prefix should be name of the module poor substitute for namespace 2020-09-13 14:09:17 +05:30			`deallocate(config_material)`
simplified 2020-09-12 19:26:59 +05:30
possibility to deallocate material.config parts 2018-06-27 00:00:41 +05:30			`end subroutine config_deallocate`

more general name (should include parsing of debug and numerics) 2018-06-14 10:09:49 +05:30			`end module config`