File CarbChemProcessCreator_Mod.F90¶

module carbchemprocesscreator_mod

   use precision_mod, only: fp
   use error_mod, only: cc_success, cc_failure, cc_error, cc_warning, errormanagertype
   use processinterface_mod
   use processcarbcheminterface_mod

   implicit none
   private

   public :: create_carbchem_process
   public :: register_carbchem_process
   public :: get_carbchem_default_config

contains

   subroutine create_carbchem_process(process, rc)
      class(ProcessInterface), allocatable, intent(out) :: process
      integer, intent(out) :: rc

      type(ProcessCarbChemInterface), allocatable :: carbchem_process
      integer :: alloc_stat

      rc = cc_success

      ! Allocate the process instance
      allocate(carbchem_process, stat=alloc_stat)
      if (alloc_stat /= 0) then
         rc = cc_failure
         return
      end if

      ! Move to polymorphic variable
      call move_alloc(carbchem_process, process)

   end subroutine create_carbchem_process

   subroutine register_carbchem_process(process_mgr, rc)
      use processmanager_mod, only: processmanagertype

      type(ProcessManagerType), intent(inout) :: process_mgr
      integer, intent(out) :: rc

      rc = cc_success

      call process_mgr%register_process( &
         name='carbchem', &
         category='chemistry', &
         description='Process for computing chemical production and loss of carbon species', &
         creator=create_carbchem_process, &
         rc=rc &
         )

   end subroutine register_carbchem_process

   subroutine get_carbchem_default_config(config_data)
      character(len=*), intent(out) :: config_data

      ! Return default YAML configuration
      config_data = &
         '# Default carbchem process configuration' // new_line('A') // &
         'process:' // new_line('A') // &
         '  name: "carbchem"' // new_line('A') // &
         '  version: "1.0.0"' // new_line('A') // &
         '  active_scheme: ""' // new_line('A') // &
         '  is_active: true' // new_line('A') // &
         '' // new_line('A') // &
         '# Scheme configuration' // new_line('A') // &
         'schemes:' // new_line('A') // &
         '  gocart:' // new_line('A') // &
         '    description: "GOCART carbon species chemical production and loss scheme"' // new_line('A') // &
         '    algorithm_type: "explicit"' // new_line('A') // &
         '    parameters:' // new_line('A') // &
         '      scale_factor: 1.0' // new_line('A') // &
         '' // new_line('A') // &
         '# Diagnostic configuration' // new_line('A') // &
         'diagnostics:' // new_line('A') // &
         '  output_frequency: 3600.0  # seconds' // new_line('A') // &
         '  output_diagnostics: true'

   end subroutine get_carbchem_default_config

end module carbchemprocesscreator_mod