Line data    Source code

       1             : !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
       2             : !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
       3             : !!!!
       4             : !!!!   MIT License
       5             : !!!!
       6             : !!!!   ParaMonte: plain powerful parallel Monte Carlo library.
       7             : !!!!
       8             : !!!!   Copyright (C) 2012-present, The Computational Data Science Lab
       9             : !!!!
      10             : !!!!   This file is part of the ParaMonte library.
      11             : !!!!
      12             : !!!!   Permission is hereby granted, free of charge, to any person obtaining a 
      13             : !!!!   copy of this software and associated documentation files (the "Software"), 
      14             : !!!!   to deal in the Software without restriction, including without limitation 
      15             : !!!!   the rights to use, copy, modify, merge, publish, distribute, sublicense, 
      16             : !!!!   and/or sell copies of the Software, and to permit persons to whom the 
      17             : !!!!   Software is furnished to do so, subject to the following conditions:
      18             : !!!!
      19             : !!!!   The above copyright notice and this permission notice shall be 
      20             : !!!!   included in all copies or substantial portions of the Software.
      21             : !!!!
      22             : !!!!   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
      23             : !!!!   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
      24             : !!!!   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
      25             : !!!!   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
      26             : !!!!   DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
      27             : !!!!   OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
      28             : !!!!   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
      29             : !!!!
      30             : !!!!   ACKNOWLEDGMENT
      31             : !!!!
      32             : !!!!   ParaMonte is an honor-ware and its currency is acknowledgment and citations.
      33             : !!!!   As per the ParaMonte library license agreement terms, if you use any parts of 
      34             : !!!!   this library for any purposes, kindly acknowledge the use of ParaMonte in your 
      35             : !!!!   work (education/research/industry/development/...) by citing the ParaMonte 
      36             : !!!!   library as described on this page:
      37             : !!!!
      38             : !!!!       https://github.com/cdslaborg/paramonte/blob/main/ACKNOWLEDGMENT.md
      39             : !!!!
      40             : !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
      41             : !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
      42             : 
      43             : !> \brief
      44             : !> This module contains the classes and procedures for setting up the `description` attribute of ParaMonte samplers.
      45             : !> For more information, see the description of this attribute in the body of the module.
      46             : !> \author Amir Shahmoradi
      47             : 
      48             : module SpecBase_Description_mod
      49             : 
      50             :     use Constants_mod, only: IK
      51             :     implicit none
      52             : 
      53             :     character(*), parameter         :: MODULE_NAME = "@SpecBase_Description_mod"
      54             :     integer(IK), parameter          :: MAX_DESCRIPTION_LEN = 4096
      55             : 
      56             :     character(:)    , allocatable   :: description ! namelist input
      57             : 
      58             :     type                            :: Description_type
      59             :         character(:), allocatable   :: val
      60             :         character(:), allocatable   :: def
      61             :         character(:), allocatable   :: null
      62             :         character(:), allocatable   :: desc
      63             :     contains
      64             :         procedure, pass             :: set => setDescription, nullifyNameListVar
      65             :     end type Description_type
      66             : 
      67             :     interface Description_type
      68             :         module procedure            :: constructDescription
      69             :     end interface Description_type
      70             : 
      71             :     private :: constructDescription, setDescription, nullifyNameListVar
      72             : 
      73             : !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
      74             : 
      75             : contains
      76             : 
      77             : !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
      78             : 
      79        1047 :     function constructDescription(methodName) result(DescriptionObj)
      80             : #if INTEL_COMPILER_ENABLED && defined DLL_ENABLED && (OS_IS_WINDOWS || defined OS_IS_DARWIN)
      81             :         !DEC$ ATTRIBUTES DLLEXPORT :: constructDescription
      82             : #endif
      83             :         use Constants_mod, only: NULL_SK
      84             :         use Decoration_mod, only: TAB
      85             :         use String_mod, only: num2str
      86             :         implicit none
      87             :         type(Description_type)  :: DescriptionObj
      88             :         character(*)            :: methodName
      89        1047 :         DescriptionObj%def = "UNDEFINED"
      90        1047 :         if (allocated(DescriptionObj%null)) deallocate(DescriptionObj%null)
      91        1047 :         allocate( character(len=MAX_DESCRIPTION_LEN) :: DescriptionObj%null )
      92        1047 :         DescriptionObj%null = repeat(NULL_SK, MAX_DESCRIPTION_LEN)
      93             :         DescriptionObj%desc = &
      94             :         "The variable 'description' contains general information about the specific " // methodName // " simulation that &
      95             :         &is going to be performed. It has no effects on the simulation and serves only as a general description of the simulation &
      96             :         &for future reference. The " // methodName // " parser automatically recognizes the C-style '\\n' escape sequence as the &
      97             :         &new-line character, and '\\\\' as the backslash character '\\' if they used in the description. For example, '\\\\n' &
      98             :         &will be converted to '\\n' on the output, while '\\n' translates to the new-line character. Other C escape sequences &
      99        1047 :         &are neither supported nor needed. The default value for description is '" // DescriptionObj%def // "'."
     100        1047 :     end function constructDescription
     101             : 
     102             : !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
     103             : 
     104        1047 :     subroutine nullifyNameListVar(DescriptionObj)
     105             : #if INTEL_COMPILER_ENABLED && defined DLL_ENABLED && (OS_IS_WINDOWS || defined OS_IS_DARWIN)
     106             :         !DEC$ ATTRIBUTES DLLEXPORT :: nullifyNameListVar
     107             : #endif
     108             :         implicit none
     109             :         class(Description_type), intent(in) :: DescriptionObj
     110        1047 :         description = DescriptionObj%null
     111        1047 :     end subroutine nullifyNameListVar
     112             : 
     113             : !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
     114             : 
     115        1047 :     subroutine setDescription(DescriptionObj,description)
     116             : #if INTEL_COMPILER_ENABLED && defined DLL_ENABLED && (OS_IS_WINDOWS || defined OS_IS_DARWIN)
     117             :         !DEC$ ATTRIBUTES DLLEXPORT :: setDescription
     118             : #endif
     119             :         implicit none
     120             :         class(Description_type), intent(inout)  :: DescriptionObj
     121             :         character(*), intent(in)                :: description
     122             :         if (allocated(DescriptionObj%val)) deallocate(DescriptionObj%val) ! LCOV_EXCL_LINE
     123        1047 :         DescriptionObj%val = trim(adjustl(description))
     124        1047 :         if (DescriptionObj%val==trim(adjustl(DescriptionObj%null))) DescriptionObj%val=trim(adjustl(DescriptionObj%def))
     125        1047 :     end subroutine setDescription
     126             : 
     127             : !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
     128             : 
     129             : end module SpecBase_Description_mod ! LCOV_EXCL_LINE