sll_m_scalar_field_1d_old.F90

Go to the documentation of this file.

!------------------------------------------------------------------------------
! SELALIB
!------------------------------------------------------------------------------
!
! MODULE: sll_scalar_field_1d
!
!
! DESCRIPTION:
!
!
! REVISION HISTORY:
! DD Mmm YYYY - Initial Version
! TODO_dd_mmm_yyyy - TODO_describe_appropriate_changes - TODO_name
!------------------------------------------------------------------------------
module sll_m_scalar_field_1d_old
 
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
#include "sll_errors.h"
#include "sll_memory.h"
#include "sll_working_precision.h"
 
   use sll_m_cartesian_meshes, only: &
      sll_t_cartesian_mesh_1d
 
   use sll_m_gnuplot, only: &
      sll_s_gnuplot_write
 
   use sll_m_scalar_field_initializers_base, only: &
      sll_p_cell_centered_field, &
      sll_p_node_centered_field
 
   implicit none
 
   private
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
   !I removed this line because, it not exists in 2d version
   !should be in base module
   !integer, parameter :: sll_p_node_centered_field = 0, sll_p_cell_centered_field = 1
 
   type scalar_field_1d
      class(sll_t_cartesian_mesh_1d), pointer :: mesh
      sll_real64, dimension(:), pointer       :: data
      sll_int32                               :: data_position
      character(len=64)                       :: name
   end type scalar_field_1d
 
   abstract interface
      function scalar_function_1d(eta1)
         use sll_m_working_precision
         sll_real64 :: scalar_function_1d
         sll_real64, intent(in)  :: eta1
      end function scalar_function_1d
   end interface
 
contains   ! *i****************************************************************
   ! this used to be new_scalar_field_1d
   subroutine initialize_scalar_field_1d( &
      this, &
      field_name, &
      mesh, &
      data_position, &
      init_function)
 
      class(scalar_field_1d), intent(inout)   :: this
      character(len=*), intent(in)            :: field_name
      class(sll_t_cartesian_mesh_1d), pointer   :: mesh
      sll_int32, intent(in)                   :: data_position
      procedure(scalar_function_1d), optional :: init_function
 
      character(len=*), parameter :: this_sub_name = 'initialize_scalar_field_1d'
 
      sll_int32  :: ierr
      sll_int32  :: num_cells1
      sll_int32  :: num_pts1
      sll_int32  :: i1
      sll_real64 :: eta1
      sll_real64 :: delta1
 
      sll_warning(this_sub_name, 'This scalar field 1d object is deprecated.')
 
      this%mesh => mesh
      this%name = trim(field_name)
      num_cells1 = mesh%num_cells
      num_pts1 = mesh%num_cells + 1
 
      this%data_position = data_position
      if (data_position == sll_p_node_centered_field) then
         sll_allocate(this%data(num_pts1), ierr)
         if (present(init_function)) then
            do i1 = 1, num_pts1
               this%data(i1) = init_function(mesh%eta_min + (i1 - 1)*mesh%delta_eta)
            end do
         else
            this%data = 0.0_f64 ! initialize to zero
         end if
      else if (data_position == sll_p_cell_centered_field) then
         sll_allocate(this%data(num_cells1), ierr)
         if (present(init_function)) then
            delta1 = 1.0_f64/real(num_cells1, f64)
            eta1 = 0.5_f64*delta1
            do i1 = 1, num_cells1
               this%data(i1) = init_function(eta1)
               eta1 = eta1 + delta1
            end do
         else
            this%data = 0.0_f64 ! initialize to zero
         end if
      end if
   end subroutine initialize_scalar_field_1d
 
   ! need to do something about deallocating the field proper, when allocated
   ! in the heap...
   subroutine delete_scalar_field_1d(this)
      type(scalar_field_1d), pointer :: this
      sll_int32                      :: ierr
      nullify (this%mesh)
      sll_deallocate(this%data, ierr)
   end subroutine delete_scalar_field_1d
 
   subroutine write_scalar_field_1d( &
      scalar_field, &
      multiply_by_jacobian, &
      output_file_name, &
      output_format)
      class(scalar_field_1d)                  :: scalar_field
      !sll_real64, dimension(:), pointer      :: x1_array
      logical, optional                       :: multiply_by_jacobian
      sll_int32, optional                     :: output_format
      character(len=*), optional              :: output_file_name
      character(len=64)                       :: file_name
 
      if (present(multiply_by_jacobian)) then
         print *, 'multiply_by_jacobian option is not implemented'
      end if
 
      if (present(output_format)) then
         print *, 'There is just gnuplot format available'
      end if
      if (present(output_file_name)) then
         file_name = output_file_name
      else
         file_name = scalar_field%name
      end if
 
      call sll_s_gnuplot_write(scalar_field%data, file_name, 1)
   end subroutine write_scalar_field_1d
 
end module sll_m_scalar_field_1d_old