curv_briggs.F90

Go to the documentation of this file.

!! Copyright (C) 2002-2006 M. Marques, A. Castro, A. Rubio, G. Bertsch
!!
!! This program is free software; you can redistribute it and/or modify
!! it under the terms of the GNU General Public License as published by
!! the Free Software Foundation; either version 2, or (at your option)
!! any later version.
!!
!! This program is distributed in the hope that it will be useful,
!! but WITHOUT ANY WARRANTY; without even the implied warranty of
!! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
!! GNU General Public License for more details.
!!
!! You should have received a copy of the GNU General Public License
!! along with this program; if not, write to the Free Software
!! Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
!! 02110-1301, USA.
!!
 
#include "global.h"
 
 
module curv_briggs_oct_m
  use coordinate_system_oct_m
  use debug_oct_m
  use global_oct_m
  use messages_oct_m
  use namespace_oct_m
  use parser_oct_m
  use profiling_oct_m
 
  implicit none
 
  private
  public ::                     &
    curv_briggs_t,              &
    curv_briggs_copy
 
  type, extends(coordinate_system_t) :: curv_briggs_t
    private
    real(real64), allocatable :: lsize(:)
    real(real64) :: beta
  contains
    procedure :: to_cartesian => curv_briggs_to_cartesian
    procedure :: from_cartesian => curv_briggs_from_cartesian
    procedure :: write_info => curv_briggs_write_info
    procedure :: surface_element => curv_briggs_surface_element
    procedure :: jacobian => curv_briggs_jacobian
    procedure :: jacobian_inverse => curv_briggs_jacobian_inverse
    final :: curv_briggs_finalize
  end type curv_briggs_t
 
  interface curv_briggs_t
    procedure curv_briggs_constructor
  end interface curv_briggs_t
 
contains
 
  ! ---------------------------------------------------------
  function curv_briggs_constructor(namespace, dim, lsize, spacing) result(briggs)
    type(namespace_t),   intent(in)  :: namespace
    integer,             intent(in)  :: dim
    real(real64),        intent(in)  :: lsize(1:dim)
    real(real64),        intent(in)  :: spacing(1:dim)
    class(curv_briggs_t), pointer :: briggs
 
    integer :: idim
 
    push_sub(curv_briggs_constructor)
 
    safe_allocate(briggs)
 
    briggs%local_basis = .true.
    briggs%orthogonal = .true. ! This needs to be checked
    briggs%dim = dim
    safe_allocate(briggs%lsize(1:dim))
    briggs%lsize(1:dim) = lsize(1:dim)
 
    call parse_variable(namespace, 'CurvBriggsBeta', m_half, briggs%beta)
 
    if (briggs%beta < m_zero .or. briggs%beta > m_one) then
      message(1) = 'The parameter "CurvBriggsBeta" must lie between 0 and 1.'
      call messages_fatal(1, namespace=namespace)
    end if
 
    briggs%min_mesh_scaling_product = m_one
    do idim = 1, briggs%dim
      ! corresponds to the distance of grid points at [+spacing/2,-spacing/2]
      briggs%min_mesh_scaling_product = briggs%min_mesh_scaling_product * (m_one / &
        (m_one - briggs%lsize(idim) * briggs%beta / (m_pi * spacing(idim)) * sin(m_pi * spacing(idim) / briggs%lsize(idim))))
    end do
 
    pop_sub(curv_briggs_constructor)
  end function curv_briggs_constructor
 
  ! ---------------------------------------------------------
  subroutine curv_briggs_finalize(this)
    type(curv_briggs_t), intent(inout) :: this
 
    push_sub(curv_briggs_finalize)
 
    safe_deallocate_a(this%lsize)
 
    pop_sub(curv_briggs_finalize)
  end subroutine curv_briggs_finalize
 
  ! ---------------------------------------------------------
  subroutine curv_briggs_copy(this_out, this_in)
    type(curv_briggs_t), intent(inout) :: this_out
    type(curv_briggs_t), intent(in)    :: this_in
 
    push_sub(curv_briggs_copy)
 
    safe_allocate_source_a(this_out%lsize, this_in%lsize)
    this_out%beta = this_in%beta
 
    pop_sub(curv_briggs_copy)
  end subroutine curv_briggs_copy
 
  ! ---------------------------------------------------------
  pure function curv_briggs_to_cartesian(this, chi) result(xx)
    class(curv_briggs_t), target, intent(in)  :: this
    real(real64),                 intent(in)  :: chi(:)
    real(real64) :: xx(1:this%dim)
 
    ! no PUSH_SUB, called too often
 
    xx = chi - this%lsize*this%beta/(m_two*m_pi)*sin(m_two*m_pi*chi/this%lsize)
 
  end function curv_briggs_to_cartesian
 
  ! ---------------------------------------------------------
  function curv_briggs_from_cartesian(this, xx) result(chi)
    class(curv_briggs_t), target, intent(in)  :: this
    real(real64),                 intent(in)  :: xx(:)
    real(real64) :: chi(1:this%dim)
 
    ! no PUSH_SUB, called too often
 
    chi = m_zero
    message(1) = "Internal error in curv_briggs_from_cartesian"
    call messages_fatal(1)
 
  end function curv_briggs_from_cartesian
 
  ! ---------------------------------------------------------
  subroutine curv_briggs_write_info(this, iunit, namespace)
    class(curv_briggs_t),         intent(in) :: this
    integer,            optional, intent(in) :: iunit
    type(namespace_t),  optional, intent(in) :: namespace
 
    push_sub(curv_briggs_write_info)
 
    write(message(1), '(a)') '  Curvilinear Method = briggs'
    call messages_info(1, iunit=iunit, namespace=namespace)
 
    pop_sub(curv_briggs_write_info)
  end subroutine curv_briggs_write_info
 
  ! ---------------------------------------------------------
  real(real64) function curv_briggs_surface_element(this, idir) result(ds)
    class(curv_briggs_t), intent(in) :: this
    integer,              intent(in) :: idir
 
    ds = m_zero
    message(1) = 'Surface element with briggs curvilinear coordinates not implemented'
    call messages_fatal(1)
 
  end function curv_briggs_surface_element
 
  ! ---------------------------------------------------------
  function curv_briggs_jacobian(this, chi) result(jacobian)
    class(curv_briggs_t), intent(in)  :: this
    real(real64),         intent(in)  :: chi(:)
    real(real64) :: jacobian(1:this%dim, 1:this%dim)
 
    integer :: idim
 
    ! Jacobian is diagonal in this method
    jacobian(:, :) = m_zero
    do idim = 1, this%dim
      jacobian(idim, idim) = m_one - this%beta*cos(m_two*m_pi*chi(idim)/this%lsize(idim))
    end do
 
  end function curv_briggs_jacobian
 
  ! ---------------------------------------------------------
  function curv_briggs_jacobian_inverse(this, chi) result(jacobian_inverse)
    class(curv_briggs_t), intent(in)  :: this
    real(real64),         intent(in)  :: chi(:)
    real(real64) :: jacobian_inverse(1:this%dim, 1:this%dim)
 
    integer :: idim
 
    jacobian_inverse = this%jacobian(chi)
    do idim = 1, this%dim
      jacobian_inverse(idim, idim) = m_one/jacobian_inverse(idim, idim)
    end do
 
  end function curv_briggs_jacobian_inverse
 
end module curv_briggs_oct_m
 
!! Local Variables:
!! mode: f90
!! coding: utf-8
!! End: