coordinate_system.F90

Go to the documentation of this file.

!! Copyright (C) 2021 M. Oliveira
!!
!! 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 coordinate_system_oct_m
  use, intrinsic :: iso_fortran_env
  use namespace_oct_m
  implicit none
 
  private
  public :: coordinate_system_t
 
  type, abstract :: coordinate_system_t
    logical :: local_basis
    logical :: orthogonal
    integer :: dim
    real(real64) :: min_mesh_scaling_product
  contains
    generic   :: vector_from_cartesian => dvector_from_cartesian, zvector_from_cartesian
    
    procedure :: dvector_from_cartesian => dcoordinate_system_vector_from_cartesian
    
    procedure :: zvector_from_cartesian => zcoordinate_system_vector_from_cartesian
    
    generic   :: covector_to_cartesian => dcovector_to_cartesian, zcovector_to_cartesian
    
    procedure :: dcovector_to_cartesian => dcoordinate_system_covector_to_cartesian
    
    procedure :: zcovector_to_cartesian => zcoordinate_system_covector_to_cartesian
    
    procedure(coordinate_system_to_cartesian),           deferred :: to_cartesian
    
    procedure(coordinate_system_from_cartesian),         deferred :: from_cartesian
    
    procedure(coordinate_system_det_jac),                deferred :: det_jac
    
    procedure(coordinate_system_write_info),             deferred :: write_info
    
    procedure(coordinates_surface_element),              deferred :: surface_element
    
  end type coordinate_system_t
 
  abstract interface
    ! ---------------------------------------------------------
    function coordinate_system_to_cartesian(this, chi) result(xx)
      import coordinate_system_t
      import real64
      class(coordinate_system_t), target, intent(in)  :: this
      real(real64),                       intent(in)  :: chi(:)
      real(real64) :: xx(1:this%dim)
    end function coordinate_system_to_cartesian
 
    ! ---------------------------------------------------------
    function coordinate_system_from_cartesian(this, xx) result(chi)
      import coordinate_system_t
      import real64
      class(coordinate_system_t), target, intent(in)  :: this
      real(real64),                       intent(in)  :: xx(:)
      real(real64) :: chi(1:this%dim)
    end function coordinate_system_from_cartesian
 
    ! ---------------------------------------------------------
    real(real64) function coordinate_system_det_jac(this, xx, chi) result(jdet)
      import coordinate_system_t
      import real64
      class(coordinate_system_t), intent(in)  :: this
      real(real64),               intent(in)  :: xx(:)
      real(real64),               intent(in)  :: chi(:)
    end function coordinate_system_det_jac
 
    ! ---------------------------------------------------------
    subroutine coordinate_system_write_info(this, iunit, namespace)
      import coordinate_system_t
      import namespace_t
      class(coordinate_system_t),           intent(in) :: this
      integer,                    optional, intent(in) :: iunit
      type(namespace_t),          optional, intent(in) :: namespace
    end subroutine coordinate_system_write_info
 
    ! ---------------------------------------------------------
    real(real64) function coordinates_surface_element(this, idir) result(ds)
      import coordinate_system_t
      import real64
      class(coordinate_system_t), intent(in) :: this
      integer,                    intent(in) :: idir
    end function coordinates_surface_element
  end interface
 
contains
 
  ! ---------------------------------------------------------
  subroutine dcoordinate_system_vector_from_cartesian(this, xx, vv, src)
    class(coordinate_system_t), intent(in)    :: this
    real(real64),               intent(in)    :: xx(:)
    real(real64),               intent(inout) :: vv(:)
    real(real64), optional,     intent(in)    :: src(:)
 
    ! Classes that want to provide this method must override it.
    assert(.false.)
 
  end subroutine dcoordinate_system_vector_from_cartesian
 
  ! ---------------------------------------------------------
  subroutine zcoordinate_system_vector_from_cartesian(this, xx, vv, src)
    class(coordinate_system_t), intent(in)    :: this
    real(real64),               intent(in)    :: xx(:)
    complex(real64),            intent(inout) :: vv(:)
    complex(real64), optional,  intent(in)    :: src(:)
 
    ! Classes that want to provide this method must override it.
    ! Note that when the basis is local, this transformantion depends on the
    ! position
    assert(.false.)
 
  end subroutine zcoordinate_system_vector_from_cartesian
 
  ! ---------------------------------------------------------
  subroutine dcoordinate_system_covector_to_cartesian(this, xx, cv, src)
    class(coordinate_system_t), intent(in)    :: this
    real(real64),               intent(in)    :: xx(:)
    real(real64),               intent(inout) :: cv(:)
    real(real64), optional,     intent(in)    :: src(:)
 
    ! Classes that want to provide this method must override it.
    assert(.false.)
 
  end subroutine dcoordinate_system_covector_to_cartesian
 
  ! ---------------------------------------------------------
  subroutine zcoordinate_system_covector_to_cartesian(this, xx, cv, src)
    class(coordinate_system_t), intent(in)    :: this
    real(real64),               intent(in)    :: xx(:)
    complex(real64),            intent(inout) :: cv(:)
    complex(real64), optional,  intent(in)    :: src(:)
 
    ! Classes that want to provide this method must override it.
    assert(.false.)
 
  end subroutine zcoordinate_system_covector_to_cartesian
 
end module coordinate_system_oct_m
 
!! Local Variables:
!! mode: f90
!! coding: utf-8
!! End: