mom_domains::clone_mom_domain Interface Reference

Detailed Description

Copy one MOM_domain_type into another.

Definition at line 99 of file MOM_domains.F90.

Private functions
subroutine	clone_md_to_md (MD_in, MOM_dom, min_halo, halo_size, symmetric, domain_name, turns)
	clone_MD_to_MD copies one MOM_domain_type into another, while allowing some properties of the new type to differ from the original one. More...
subroutine	clone_md_to_d2d (MD_in, mpp_domain, min_halo, halo_size, symmetric, domain_name, turns)
	clone_MD_to_d2D uses information from a MOM_domain_type to create a new domain2d type, while allowing some properties of the new type to differ from the original one. More...

Detailed Description

Copy one MOM_domain_type into another.

Definition at line 99 of file MOM_domains.F90.

Functions and subroutines

clone_md_to_d2d()

subroutine mom_domains::clone_mom_domain::clone_md_to_d2d ( type(mom_domain_type), intent(in)  MD_in, type(domain2d), intent(inout)  mpp_domain, integer, dimension(2), intent(inout), optional  min_halo, integer, intent(in), optional  halo_size, logical, intent(in), optional  symmetric, character(len=*), intent(in), optional  domain_name, integer, intent(in), optional  turns  )

private

clone_MD_to_d2D uses information from a MOM_domain_type to create a new domain2d type, while allowing some properties of the new type to differ from the original one.

Parameters

[in]	md_in	An existing MOM_domain to be cloned
[in,out]	mpp_domain	The new mpp_domain to be set up
[in,out]	min_halo	If present, this sets the
[in]	halo_size	If present, this sets the halo size for the domain in the i- and j-directions. min_halo and halo_size can not both be present.
[in]	symmetric	If present, this specifies whether the new domain is symmetric, regardless of whether the macro SYMMETRIC_MEMORY_ is defined.
[in]	domain_name	A name for the new domain, "MOM"
[in]	turns	If true, swap X and Y axes

Definition at line 1737 of file MOM_domains.F90.

  type(mom_domain_type), intent(in)    :: md_in !< An existing MOM_domain to be cloned
  type(domain2d),        intent(inout) :: mpp_domain !< The new mpp_domain to be set up
  integer, dimension(2), &
               optional, intent(inout) :: min_halo !< If present, this sets the
                                  !! minimum halo size for this domain in the i- and j-
                                  !! directions, and returns the actual halo size used.
  integer,     optional, intent(in)    :: halo_size !< If present, this sets the halo
                                  !! size for the domain in the i- and j-directions.
                                  !! min_halo and halo_size can not both be present.
  logical,     optional, intent(in)    :: symmetric !< If present, this specifies
                                  !! whether the new domain is symmetric, regardless of
                                  !! whether the macro SYMMETRIC_MEMORY_ is defined.
  character(len=*), &
               optional, intent(in)    :: domain_name !< A name for the new domain, "MOM"
                                  !! if missing.
  integer, optional, intent(in) :: turns   !< If true, swap X and Y axes

  integer :: global_indices(4), layout(2), io_layout(2)
  integer :: x_flags, y_flags, niglobal, njglobal, nihalo, njhalo
  logical :: symmetric_dom
  character(len=64) :: dom_name

  if (present(turns)) &
    call mom_error(fatal, "Rotation not supported for MOM_domain to domain2d")

! Save the extra data for creating other domains of different resolution that overlay this domain
  niglobal = md_in%niglobal ; njglobal = md_in%njglobal
  nihalo = md_in%nihalo ; njhalo = md_in%njhalo

  symmetric_dom = md_in%symmetric

  x_flags = md_in%X_FLAGS ; y_flags = md_in%Y_FLAGS
  layout(:) = md_in%layout(:) ; io_layout(:) = md_in%io_layout(:)

  if (present(halo_size) .and. present(min_halo)) call mom_error(fatal, &
      "clone_MOM_domain can not have both halo_size and min_halo present.")

  if (present(min_halo)) then
    nihalo = max(nihalo, min_halo(1))
    njhalo = max(njhalo, min_halo(2))
    min_halo(1) = nihalo ; min_halo(2) = njhalo
  endif

  if (present(halo_size)) then
    nihalo = halo_size ; njhalo = halo_size
  endif

  if (present(symmetric)) then ; symmetric_dom = symmetric ; endif

  dom_name = "MOM"
  if (present(domain_name)) dom_name = trim(domain_name)

  global_indices(1) = 1 ; global_indices(2) = niglobal
  global_indices(3) = 1 ; global_indices(4) = njglobal
  if (associated(md_in%maskmap)) then
    call mom_define_domain( global_indices, layout, mpp_domain, &
                xflags=x_flags, yflags=y_flags, &
                xhalo=nihalo, yhalo=njhalo, &
                symmetry = symmetric, name=dom_name, &
                maskmap=md_in%maskmap )
  else
    call mom_define_domain( global_indices, layout, mpp_domain, &
                xflags=x_flags, yflags=y_flags, &
                xhalo=nihalo, yhalo=njhalo, &
                symmetry = symmetric, name=dom_name)
  endif

  if ((io_layout(1) + io_layout(2) > 0) .and. &
      (layout(1)*layout(2) > 1)) then
    call mom_define_io_domain(mpp_domain, io_layout)
  endif

clone_md_to_md()

subroutine mom_domains::clone_mom_domain::clone_md_to_md ( type(mom_domain_type), intent(in)  MD_in, type(mom_domain_type), pointer  MOM_dom, integer, dimension(2), intent(inout), optional  min_halo, integer, intent(in), optional  halo_size, logical, intent(in), optional  symmetric, character(len=*), intent(in), optional  domain_name, integer, intent(in), optional  turns  )

private

clone_MD_to_MD copies one MOM_domain_type into another, while allowing some properties of the new type to differ from the original one.

Parameters

[in]	md_in	An existing MOM_domain
	mom_dom	A pointer to a MOM_domain that will be allocated if it is unassociated, and will have data copied from MD_in
[in,out]	min_halo	If present, this sets the
[in]	halo_size	If present, this sets the halo size for the domain in the i- and j-directions. min_halo and halo_size can not both be present.
[in]	symmetric	If present, this specifies whether the new domain is symmetric, regardless of whether the macro SYMMETRIC_MEMORY_ is defined.
[in]	domain_name	A name for the new domain, "MOM"
[in]	turns	Number of quarter turns

Definition at line 1607 of file MOM_domains.F90.

  type(mom_domain_type), intent(in)    :: md_in  !< An existing MOM_domain
  type(mom_domain_type), pointer       :: mom_dom !< A pointer to a MOM_domain that will be
                                  !! allocated if it is unassociated, and will have data
                                  !! copied from MD_in
  integer, dimension(2), &
               optional, intent(inout) :: min_halo !< If present, this sets the
                                  !! minimum halo size for this domain in the i- and j-
                                  !! directions, and returns the actual halo size used.
  integer,     optional, intent(in)    :: halo_size !< If present, this sets the halo
                                  !! size for the domain in the i- and j-directions.
                                  !! min_halo and halo_size can not both be present.
  logical,     optional, intent(in)    :: symmetric !< If present, this specifies
                                  !! whether the new domain is symmetric, regardless of
                                  !! whether the macro SYMMETRIC_MEMORY_ is defined.
  character(len=*), &
               optional, intent(in)    :: domain_name !< A name for the new domain, "MOM"
                                  !! if missing.
  integer, optional, intent(in) :: turns   !< Number of quarter turns

  integer :: global_indices(4)
  logical :: mask_table_exists
  character(len=64) :: dom_name
  integer :: qturns

  qturns = 0
  if (present(turns)) qturns = turns

  if (.not.associated(mom_dom)) then
    allocate(mom_dom)
    allocate(mom_dom%mpp_domain)
    allocate(mom_dom%mpp_domain_d2)
  endif

! Save the extra data for creating other domains of different resolution that overlay this domain
  mom_dom%symmetric = md_in%symmetric
  mom_dom%nonblocking_updates = md_in%nonblocking_updates
  mom_dom%thin_halo_updates = md_in%thin_halo_updates

  if (modulo(qturns, 2) /= 0) then
    mom_dom%niglobal = md_in%njglobal ; mom_dom%njglobal = md_in%niglobal
    mom_dom%nihalo = md_in%njhalo ; mom_dom%njhalo = md_in%nihalo

    mom_dom%X_FLAGS = md_in%Y_FLAGS ; mom_dom%Y_FLAGS = md_in%X_FLAGS
    mom_dom%layout(:) = md_in%layout(2:1:-1)
    mom_dom%io_layout(:) = md_in%io_layout(2:1:-1)
  else
    mom_dom%niglobal = md_in%niglobal ; mom_dom%njglobal = md_in%njglobal
    mom_dom%nihalo = md_in%nihalo ; mom_dom%njhalo = md_in%njhalo

    mom_dom%X_FLAGS = md_in%X_FLAGS ; mom_dom%Y_FLAGS = md_in%Y_FLAGS
    mom_dom%layout(:) = md_in%layout(:)
    mom_dom%io_layout(:) = md_in%io_layout(:)
  endif

  global_indices(1) = 1 ; global_indices(2) = mom_dom%niglobal
  global_indices(3) = 1 ; global_indices(4) = mom_dom%njglobal

  if (associated(md_in%maskmap)) then
    mask_table_exists = .true.
    allocate(mom_dom%maskmap(mom_dom%layout(1), mom_dom%layout(2)))
    if (qturns /= 0) then
      call rotate_array(md_in%maskmap(:,:), qturns, mom_dom%maskmap(:,:))
    else
      mom_dom%maskmap(:,:) = md_in%maskmap(:,:)
    endif
  else
    mask_table_exists = .false.
  endif

  if (present(halo_size) .and. present(min_halo)) call mom_error(fatal, &
      "clone_MOM_domain can not have both halo_size and min_halo present.")

  if (present(min_halo)) then
    mom_dom%nihalo = max(mom_dom%nihalo, min_halo(1))
    min_halo(1) = mom_dom%nihalo
    mom_dom%njhalo = max(mom_dom%njhalo, min_halo(2))
    min_halo(2) = mom_dom%njhalo
  endif

  if (present(halo_size)) then
    mom_dom%nihalo = halo_size ; mom_dom%njhalo = halo_size
  endif

  if (present(symmetric)) then ; mom_dom%symmetric = symmetric ; endif

  dom_name = "MOM"
  if (present(domain_name)) dom_name = trim(domain_name)

  if (mask_table_exists) then
    call mom_define_domain(global_indices, mom_dom%layout, mom_dom%mpp_domain, &
                xflags=mom_dom%X_FLAGS, yflags=mom_dom%Y_FLAGS, &
                xhalo=mom_dom%nihalo, yhalo=mom_dom%njhalo, &
                symmetry=mom_dom%symmetric, name=dom_name, &
                maskmap=mom_dom%maskmap)

    global_indices(2) = global_indices(2) / 2
    global_indices(4) = global_indices(4) / 2
    call mom_define_domain(global_indices, mom_dom%layout, &
                mom_dom%mpp_domain_d2, &
                xflags=mom_dom%X_FLAGS, yflags=mom_dom%Y_FLAGS, &
                xhalo=(mom_dom%nihalo/2), yhalo=(mom_dom%njhalo/2), &
                symmetry=mom_dom%symmetric, name=dom_name, &
                maskmap=mom_dom%maskmap)
  else
    call mom_define_domain(global_indices, mom_dom%layout, mom_dom%mpp_domain, &
                xflags=mom_dom%X_FLAGS, yflags=mom_dom%Y_FLAGS, &
                xhalo=mom_dom%nihalo, yhalo=mom_dom%njhalo, &
                symmetry=mom_dom%symmetric, name=dom_name)

    global_indices(2) = global_indices(2) / 2
    global_indices(4) = global_indices(4) / 2
    call mom_define_domain(global_indices, mom_dom%layout, &
                mom_dom%mpp_domain_d2, &
                xflags=mom_dom%X_FLAGS, yflags=mom_dom%Y_FLAGS, &
                xhalo=(mom_dom%nihalo/2), yhalo=(mom_dom%njhalo/2), &
                symmetry=mom_dom%symmetric, name=dom_name)
  endif

  if ((mom_dom%io_layout(1) + mom_dom%io_layout(2) > 0) .and. &
      (mom_dom%layout(1)*mom_dom%layout(2) > 1)) then
    call mom_define_io_domain(mom_dom%mpp_domain, mom_dom%io_layout)
  endif

---

The documentation for this interface was generated from the following file:

• /home/cermak/src/MOM6.devrob/src/framework/MOM_domains.F90