scale_meshfield_base.F90

Go to the documentation of this file.

!> module FElib / Data / base
!!
!! @par Description
!!           A module for managing field data with FEM 
!!
!! @author Yuta Kawai, Team SCALE
!!
!<
#include "scaleFElib.h"
module scale_meshfield_base
 
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_io
 
  use scale_localmesh_1d, only: localmesh1d
  use scale_localmesh_2d, only: localmesh2d
  use scale_localmesh_3d, only: localmesh3d
 
  use scale_mesh_base1d, only: meshbase1d
  use scale_mesh_base2d, only: meshbase2d
  use scale_mesh_base3d, only: meshbase3d
  
  use scale_localmeshfield_base, only: &
    localmeshfieldbase,                                  &
    localmeshfield1d, localmeshfield2d, localmeshfield3d
    
  use scale_element_base, only: &
    elementbase1d, elementbase2d, elementbase3d
 
 
  !-----------------------------------------------------------------------------
  implicit none
  private
 
  !-----------------------------------------------------------------------------
  !
  !++ Public type & procedure
  ! 
 
  !> Derived type representing a field (base type)
  type, abstract, public :: meshfieldbase
    character(len=H_SHORT) :: varname  !< Variable name
    character(len=H_SHORT) :: unit     !< Unit of variable
    integer :: hist_id                 !< ID for outputting history data
    integer :: monitor_id              !< ID for monitoring variable
  contains
    procedure(meshfieldbase_get_localmeshfield), deferred, public :: getlocalmeshfield
  end type meshfieldbase
 
  interface
    subroutine meshfieldbase_get_localmeshfield( this, domID, ptr_lcmeshField )
      import meshfieldbase
      import localmeshfieldbase
      class(meshfieldbase), target, intent(in) :: this
      integer, intent(in) :: domID
      class(localmeshfieldbase), pointer, intent(out) :: ptr_lcmeshfield
    end subroutine meshfieldbase_get_localmeshfield
  end interface
 
  !------
  
  !> Derived type representing a field with 1D mesh
  type, extends(meshfieldbase), public :: meshfield1d
    type(localmeshfield1d), allocatable :: local(:) !< Array of objects with 1D field data
    class(meshbase1d), pointer :: mesh              !< Pointer to an object with a 1D computational mesh
  contains
    procedure :: init => meshfield1d_init
    procedure :: final => meshfield1d_final
    procedure :: getlocalmeshfield =>  meshfield1d_get_localmeshfield
  end type meshfield1d
 
  type, public :: meshfield1dlist
    class(meshfield1d), pointer :: ptr
  end type meshfield1dlist
 
  !> Derived type representing a field with 2D mesh
  type, extends(meshfieldbase), public :: meshfield2d
    type(localmeshfield2d), allocatable :: local(:) !< Array of objects with 2D field data
    class(meshbase2d), pointer :: mesh              !< Pointer to an object with a 2D computational mesh  
  contains
    procedure :: init => meshfield2d_init
    procedure :: final => meshfield2d_final
    procedure :: getlocalmeshfield =>  meshfield2d_get_localmeshfield
  end type meshfield2d
 
  type, public :: meshfield2dlist
    class(meshfield2d), pointer :: ptr
  end type meshfield2dlist
 
  !> Derived type representing a field with 3D mesh
  type, extends(meshfieldbase), public :: meshfield3d
    type(localmeshfield3d), allocatable :: local(:) !< Array of objects with 3D field data
    class(meshbase3d), pointer :: mesh              !< Pointer to an object with a 3D computational mesh   
  contains
    procedure :: init => meshfield3d_init
    procedure :: final => meshfield3d_final  
    procedure :: getlocalmeshfield =>  meshfield3d_get_localmeshfield
  end type meshfield3d
 
  type, public :: meshfield3dlist
    class(meshfield3d), pointer :: ptr
  end type meshfield3dlist
 
  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  
  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
 
contains
  !**** 1D **********************************************************************
 
!> Setup an object to manage a field data with a 1D computational mesh
!OCL SERIAL
  subroutine meshfield1d_init( this, varname, units, mesh, data_type )
    implicit none
    class(meshfield1d), intent(inout) :: this
    character(len=*), intent(in) :: varname       !< Variable name
    character(len=*), intent(in) :: units         !< Unit of variable
    class(meshbase1d), target, intent(in) :: mesh !< Pointer to an object for a 1D computational mesh
    integer, intent(in), optional :: data_type    !< ID of data type (all nodes or face nodes)
 
    integer :: n
    !-----------------------------------------------------------------------------
    
    this%varname = varname
    this%unit    = units
    this%mesh => mesh
    this%hist_id    = -1
    this%monitor_id = -1
    
    allocate( this%local(mesh%LOCAL_MESH_NUM) )  
    do n=1, mesh%LOCAL_MESH_NUM
      call this%local(n)%Init( mesh%lcmesh_list(n), data_type )
    end do
 
    return
  end subroutine meshfield1d_init
 
!> Finalize an object to manage a field data with a 1D computational mesh
!OCL SERIAL
  subroutine meshfield1d_final(this)
    implicit none
    class(meshfield1d), intent(inout) :: this
    
    integer :: n
    !-----------------------------------------------------------------------------
 
    do n=1, size(this%local)
      call this%local(n)%Final()
    end do
    deallocate( this%local )
 
    return
  end subroutine meshfield1d_final
 
!OCL SERIAL
  subroutine meshfield1d_get_localmeshfield( this, domID, ptr_lcmeshField )
    implicit none
 
    class(meshfield1d), target, intent(in) :: this
    integer, intent(in) :: domID
    class(localmeshfieldbase), pointer, intent(out) :: ptr_lcmeshfield
    !-----------------------------------------------------------------------------
 
    ptr_lcmeshfield => this%local(domid)
    return
  end subroutine meshfield1d_get_localmeshfield
 
  !**** 2D **********************************************************************
 
!> Setup an object to manage a field data with a 2D computational mesh
!OCL SERIAL
  subroutine meshfield2d_init( this, varname, units, mesh, data_type )
    implicit none
 
    class(meshfield2d), intent(inout) :: this
    character(len=*), intent(in) :: varname       !< Variable name
    character(len=*), intent(in) :: units         !< Unit of variable
    class(meshbase2d), target, intent(in) :: mesh !< Pointer to an object for a 2D computational mesh
    integer, intent(in), optional :: data_type
 
    integer :: n
    !-----------------------------------------------------------------------------
    
    this%varname = varname
    this%unit = units
    this%mesh => mesh
    this%hist_id = -1
 
    allocate( this%local(mesh%LOCAL_MESH_NUM) )  
    do n=1, mesh%LOCAL_MESH_NUM
      call this%local(n)%Init( mesh%lcmesh_list(n), data_type )
    end do
 
    return
  end subroutine meshfield2d_init
  
!> Finalize an object to manage a field data with a 2D computational mesh
!OCL SERIAL
  subroutine meshfield2d_final(this)
    implicit none
 
    class(meshfield2d), intent(inout) :: this
    
    integer :: n
    !-----------------------------------------------------------------------------
 
    do n=1, size(this%local)
      call this%local(n)%Final()
    end do
    deallocate( this%local )
 
    return
  end subroutine meshfield2d_final
 
!OCL SERIAL
  subroutine meshfield2d_get_localmeshfield( this, domID, ptr_lcmeshField )
    implicit none
 
    class(meshfield2d), target, intent(in) :: this
    integer, intent(in) :: domID
    class(localmeshfieldbase), pointer, intent(out) :: ptr_lcmeshfield
    !-----------------------------------------------------------------------------
 
    ptr_lcmeshfield => this%local(domid)
    return
  end subroutine meshfield2d_get_localmeshfield
 
  !**** 3D **********************************************************************
 
!> Setup an object to manage a field data with a 3D computational mesh
!OCL SERIAL
  subroutine meshfield3d_init( this, varname, units, mesh, data_type )
    implicit none
 
    class(meshfield3d), intent(inout) :: this
    character(len=*), intent(in) :: varname       !< Variable name
    character(len=*), intent(in) :: units         !< Unit of variable
    class(meshbase3d), target, intent(in) :: mesh !< Pointer to an object for a 3D computational mesh
    integer, intent(in), optional :: data_type
 
    integer :: n
    !-----------------------------------------------------------------------------
    
    this%varname = varname
    this%unit = units
    this%mesh => mesh
    this%hist_id = -1
    
    allocate( this%local(mesh%LOCAL_MESH_NUM) )  
    do n=1, mesh%LOCAL_MESH_NUM
      call this%local(n)%Init( mesh%lcmesh_list(n), data_type )
    end do
 
    return
  end subroutine meshfield3d_init
  
!> Finalize an object to manage a field data with a 3D computational mesh
!OCL SERIAL
  subroutine meshfield3d_final(this)
    implicit none
 
    class(meshfield3d), intent(inout) :: this
    
    integer :: n
    !-----------------------------------------------------------------------------
 
    do n=1, size(this%local)
      call this%local(n)%Final()
    end do
    deallocate( this%local )
 
    return
  end subroutine meshfield3d_final
 
  subroutine meshfield3d_get_localmeshfield( this, domID, ptr_lcmeshField )
    implicit none
 
    class(meshfield3d), target, intent(in) :: this
    integer, intent(in) :: domID
    class(localmeshfieldbase), pointer, intent(out) :: ptr_lcmeshfield
    !-----------------------------------------------------------------------------
 
    ptr_lcmeshfield => this%local(domid)
    return
  end subroutine meshfield3d_get_localmeshfield
 
end module scale_meshfield_base