modelexportmodule Module Reference

This module contains the ModelExportModule. More...

Data Types
type	exportmodeltype
	export model type More...

Functions/Subroutines
logical(lgp) function, public	nc_export_active ()
	is netcdf export configured for any model More...
subroutine, public	modelexports_create (iout)
	create export container variable for all local models More...
subroutine, public	modelexports_post_prepare ()
	export model list post prepare step More...
subroutine, public	modelexports_post_step ()
	export model list post step More...
subroutine, public	modelexports_destroy ()
	destroy export model list More...
subroutine	init (this, loaders, disenum, iout)
	initialize model export container variable More...
subroutine	post_prepare (this)
	model export container post prepare step actions More...
subroutine	post_step (this)
	model export container post step actions More...
subroutine	destroy (this)
	destroy model export container More...
subroutine	add_export_model (export_model)
	add model export object to list More...
class(exportmodeltype) function, pointer, public	get_export_model (idx)
	get model export object by index More...

Variables
type(listtype), public	export_models

Detailed Description

This modeule defines the local list of model exports. It is not dependent on netcdf or other external libraries.

Function/Subroutine Documentation

add_export_model()

subroutine modelexportmodule::add_export_model ( type(exportmodeltype), intent(inout), pointer  export_model )

private

Definition at line 253 of file ModelExport.f90.

    type(ExportModelType), pointer, intent(inout) :: export_model
    class(*), pointer :: obj
    obj => export_model
    call export_models%Add(obj)

Here is the caller graph for this function:

destroy()

subroutine modelexportmodule::destroy ( class(exportmodeltype), intent(inout)  this )

private

Definition at line 241 of file ModelExport.f90.

    class(ExportModelType), intent(inout) :: this
    if (associated(this%nc_export)) then
      call this%nc_export%destroy()
      deallocate (this%nc_export)
      nullify (this%nc_export)
    end if

get_export_model()

class(exportmodeltype) function, pointer, public modelexportmodule::get_export_model

(

integer(i4b), intent(in)

idx

)

Parameters

[in]

idx

package number

Definition at line 263 of file ModelExport.f90.

    integer(I4B), intent(in) :: idx !< package number
    class(ExportModelType), pointer :: res
    class(*), pointer :: obj
    ! initialize res
    nullify (res)
    ! get the object from the list
    obj => export_models%GetItem(idx)
    if (associated(obj)) then
      select type (obj)
      class is (exportmodeltype)
        res => obj
      end select
    end if

Here is the caller graph for this function:

init()

subroutine modelexportmodule::init ( class(exportmodeltype), intent(inout)  this, type(modeldynamicpkgstype), intent(in), pointer  loaders, integer(i4b), intent(in)  disenum, integer(i4b), intent(in)  iout  )

private

Definition at line 201 of file ModelExport.f90.

    use ncmodelexportmodule, only: netcdf_undef
    class(ExportModelType), intent(inout) :: this
    type(ModelDynamicPkgsType), pointer, intent(in) :: loaders
    integer(I4B), intent(in) :: disenum
    integer(I4B), intent(in) :: iout
    this%loaders => loaders
    this%modelname = loaders%modelname
    this%modeltype = loaders%modeltype
    this%modelfname = loaders%modelfname
    this%nc_fname = ''
    this%nctype = netcdf_undef
    this%disenum = disenum
    this%iout = iout
    nullify (this%nc_export)

modelexports_create()

subroutine, public modelexportmodule::modelexports_create

(

integer(i4b), intent(in)

iout

)

Definition at line 76 of file ModelExport.f90.

    use inputloadtypemodule, only: model_dynamic_pkgs
    use memorymanagermodule, only: mem_setptr
    use memorymanagerextmodule, only: mem_set_value
    use memoryhelpermodule, only: create_mem_path
    use inputloadtypemodule, only: getdynamicmodelfromlist
    use simvariablesmodule, only: idm_context
    use ncmodelexportmodule, only: netcdf_mesh2d, netcdf_structured
    use sourcecommonmodule, only: file_ext
    integer(I4B), intent(in) :: iout
    type(ModelDynamicPkgsType), pointer :: model_dynamic_input
    type(ExportModelType), pointer :: export_model
    character(len=LENMEMPATH) :: modelnam_mempath, model_mempath, ext
    integer(I4B), pointer :: disenum
    integer(I4B) :: n
    logical(LGP) :: found
 
    do n = 1, model_dynamic_pkgs%Count()
      ! allocate and initialize
      allocate (export_model)
 
      ! set pointer to dynamic input model instance
      model_dynamic_input => getdynamicmodelfromlist(model_dynamic_pkgs, n)
 
      ! set input mempaths
      modelnam_mempath = &
        create_mem_path(component=model_dynamic_input%modelname, &
                        subcomponent='NAM', context=idm_context)
      model_mempath = create_mem_path(component=model_dynamic_input%modelname, &
                                      context=idm_context)
      ! set pointer to dis enum type
      call mem_setptr(disenum, 'DISENUM', model_mempath)
 
      ! initialize model
      call export_model%init(model_dynamic_input, disenum, iout)
 
      ! update NetCDF fileout name if provided
      call mem_set_value(export_model%nc_fname, 'NCMESH2DFILE', &
                         modelnam_mempath, found)
      if (found) then
        export_model%nctype = netcdf_mesh2d
      else
        call mem_set_value(export_model%nc_fname, 'NCSTRUCTFILE', &
                           modelnam_mempath, found)
        if (found) then
          export_model%nctype = netcdf_structured
        end if
      end if
 
      if (found) then
        ext = file_ext(export_model%nc_fname)
        if (ext /= 'nc') then
          errmsg = 'NetCDF output file name must use ".nc" extension. '// &
                   'Filename="'//trim(export_model%nc_fname)//'".'
          call store_error(errmsg)
          call store_error_filename(export_model%modelfname)
        end if
      end if
 
      ! add model to list
      call add_export_model(export_model)
    end do

Here is the call graph for this function:

Here is the caller graph for this function:

modelexports_destroy()

subroutine, public modelexportmodule::modelexports_destroy

Definition at line 178 of file ModelExport.f90.

    class(*), pointer :: obj
    class(ExportModelType), pointer :: export_model
    integer(I4B) :: n
    do n = 1, export_models%Count()
      obj => export_models%GetItem(n)
      if (associated(obj)) then
        select type (obj)
        class is (exportmodeltype)
          export_model => obj
          call export_model%destroy()
          deallocate (export_model)
          nullify (export_model)
        end select
      end if
    end do
    !
    call export_models%clear()

Here is the caller graph for this function:

modelexports_post_prepare()

subroutine, public modelexportmodule::modelexports_post_prepare

Definition at line 142 of file ModelExport.f90.

    class(*), pointer :: obj
    class(ExportModelType), pointer :: export_model
    integer(I4B) :: n
    do n = 1, export_models%Count()
      obj => export_models%GetItem(n)
      if (associated(obj)) then
        select type (obj)
        class is (exportmodeltype)
          export_model => obj
          call export_model%post_prepare()
        end select
      end if
    end do

Here is the caller graph for this function:

modelexports_post_step()

subroutine, public modelexportmodule::modelexports_post_step

Definition at line 160 of file ModelExport.f90.

    class(*), pointer :: obj
    class(ExportModelType), pointer :: export_model
    integer(I4B) :: n
    do n = 1, export_models%Count()
      obj => export_models%GetItem(n)
      if (associated(obj)) then
        select type (obj)
        class is (exportmodeltype)
          export_model => obj
          call export_model%post_step()
        end select
      end if
    end do

Here is the caller graph for this function:

nc_export_active()

logical(lgp) function, public modelexportmodule::nc_export_active

Definition at line 59 of file ModelExport.f90.

    use ncmodelexportmodule, only: netcdf_undef
    logical(LGP) :: active
    integer(I4B) :: n
    type(ExportModelType), pointer :: export_model
    active = .false.
    do n = 1, export_models%Count()
      export_model => get_export_model(n)
      if (export_model%nctype /= netcdf_undef) then
        active = .true.
        exit
      end if
    end do

Here is the call graph for this function:

Here is the caller graph for this function:

post_prepare()

subroutine modelexportmodule::post_prepare

(

class(exportmodeltype), intent(inout)

this

)

Definition at line 221 of file ModelExport.f90.

    class(ExportModelType), intent(inout) :: this
    if (associated(this%nc_export)) then
      call this%nc_export%export_input()
    end if

post_step()

subroutine modelexportmodule::post_step ( class(exportmodeltype), intent(inout)  this )

private

Definition at line 231 of file ModelExport.f90.

    class(ExportModelType), intent(inout) :: this
    if (associated(this%nc_export)) then
      call this%nc_export%step()
    end if

Variable Documentation

export_models

type(listtype), public modelexportmodule::export_models

Definition at line 30 of file ModelExport.f90.

  type(ListType) :: export_models