DAMASK_EICMD/src/config.f90

!--------------------------------------------------------------------------------------------------
!> @author Martin Diehl, Max-Planck-Institut für Eisenforschung GmbH
!> @brief Reads in the material, numerics & debug configuration from their respective file
!> @details Reads the material configuration file, where solverJobName.yaml takes
!! precedence over material.yaml.
!--------------------------------------------------------------------------------------------------
module config
  use IO
  use YAML_parse
  use YAML_types
  use results
  use parallelization

  implicit none
  private

  class(tNode), pointer, public :: &
    config_material, &
    config_numerics, &
    config_debug

  public :: &
    config_init, &
    config_deallocate

contains

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

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


  call parse_material
  call parse_numerics
  call parse_debug

end subroutine config_init


!--------------------------------------------------------------------------------------------------
!> @brief Read material.yaml or <jobname>.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')

  print*, 'reading material.yaml'; flush(IO_STDOUT)
  fileContent = IO_read('material.yaml')

  if (worldrank == 0) then
    call results_openJobFile(parallel=.false.)
    call results_writeDataset_str(fileContent,'setup','material.yaml','DAMASK main configuration')
    call results_closeJobFile
  endif

  config_material => YAML_parse_str(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

    print*, 'reading numerics.yaml'; flush(IO_STDOUT)
    fileContent = IO_read('numerics.yaml')

    if (worldrank == 0) then
      call results_openJobFile(parallel=.false.)
      call results_writeDataset_str(fileContent,'setup','numerics.yaml','numerics configuration (optional)')
      call results_closeJobFile
    endif

    config_numerics => YAML_parse_str(fileContent)

  endif

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

    print*, 'reading debug.yaml'; flush(IO_STDOUT)
    fileContent = IO_read('debug.yaml')

    if (worldrank == 0) then
      call results_openJobFile(parallel=.false.)
      call results_writeDataset_str(fileContent,'setup','debug.yaml','debug configuration (optional)')
      call results_closeJobFile
    endif

    config_debug => YAML_parse_str(fileContent)

  endif

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`
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`!> @brief Reads in the material, numerics & debug configuration from their respective file`
			`!> @details Reads the material configuration file, where solverJobName.yaml takes`
handling of MPI in 'parallelization' 2020-09-13 13:49:38 +05:30			`!! precedence over material.yaml.`
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`
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`use results`
			`use parallelization`
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			`implicit none`
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
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`class(tNode), 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			`!--------------------------------------------------------------------------------------------------`
parsing material.config and debug.config 2019-03-13 02:57:45 +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
standard conforming name 2020-09-22 16:39:12 +05:30			`print'(/,a)', ' <<<+- config init -+>>>'; flush(IO_STDOUT)`
handling of MPI in 'parallelization' 2020-09-13 13:49:38 +05:30
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30
Restructuring for material.yaml 2020-08-15 19:32:10 +05:30			`call parse_material`
			`call parse_numerics`
			`call parse_debug`

			`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			`!--------------------------------------------------------------------------------------------------`
polishing 2020-09-14 00:58:53 +05:30			`!> @brief Read material.yaml or <jobname>.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)`
			`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
jobname.yaml not supported anymore 2021-02-13 04:05:06 +05:30			`print*, 'reading material.yaml'; flush(IO_STDOUT)`
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`fileContent = IO_read('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`
			`call results_openJobFile(parallel=.false.)`
			`call results_writeDataset_str(fileContent,'setup','material.yaml','DAMASK main configuration')`
			`call results_closeJobFile`
			`endif`
read file only once (per process) 2021-07-27 12:05:52 +05:30
			`config_material => YAML_parse_str(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
standard conforming name 2020-09-22 16:39:12 +05:30			`print*, 'reading numerics.yaml'; flush(IO_STDOUT)`
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`fileContent = IO_read('numerics.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`
			`call results_openJobFile(parallel=.false.)`
			`call results_writeDataset_str(fileContent,'setup','numerics.yaml','numerics configuration (optional)')`
			`call results_closeJobFile`
			`endif`
read file only once (per process) 2021-07-27 12:05:52 +05:30
			`config_numerics => YAML_parse_str(fileContent)`

clearer structure 2019-03-13 02:18:33 +05:30			`endif`

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
standard conforming name 2020-09-22 16:39:12 +05:30			`print*, 'reading debug.yaml'; flush(IO_STDOUT)`
make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`fileContent = IO_read('debug.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`
			`call results_openJobFile(parallel=.false.)`
			`call results_writeDataset_str(fileContent,'setup','debug.yaml','debug configuration (optional)')`
			`call results_closeJobFile`
			`endif`
read file only once (per process) 2021-07-27 12:05:52 +05:30
			`config_debug => YAML_parse_str(fileContent)`

make results self-contained for reproducibility ToDo: same functionality for load and geom 2021-07-27 10:58:35 +05:30			`endif`
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`