sources_base.f90

Go to the documentation of this file.

!#############################################################################
!#                                                                           #
!# fosite - 3D hydrodynamical simulation program                             #
!# module: sources_generic.f90                                               #
!#                                                                           #
!# Copyright (C) 2007-2021                                                   #
!# Tobias Illenseer <tillense@astrophysik.uni-kiel.de>                       #
!# Björn Sperling   <sperling@astrophysik.uni-kiel.de>                       #
!#                                                                           #
!# 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 of the License, 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, GOOD TITLE or        #
!# NON INFRINGEMENT.  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., 675 Mass Ave, Cambridge, MA 02139, USA.                 #
!#                                                                           #
!#############################################################################
!----------------------------------------------------------------------------!
!----------------------------------------------------------------------------!
!----------------------------------------------------------------------------!
MODULE sources_base_mod
  USE logging_base_mod
  USE mesh_base_mod
  USE marray_compound_mod
  USE marray_base_mod
  USE gravity_base_mod
  USE physics_base_mod
  USE fluxes_base_mod
  USE common_dict
#if defined(HAVE_FFTW)
  USE fftw
#endif
  IMPLICIT NONE
  !--------------------------------------------------------------------------!
  PRIVATE
  TYPE, ABSTRACT, EXTENDS(logging_base) :: sources_base
     CLASS(sources_base), POINTER    :: next => null() 
     REAL                            :: time
     REAL                            :: cvis
!      REAL                            :: gparam         !< geometry parameter
!      REAL, DIMENSION(:,:,:), POINTER :: invr         !< 1./radius
!      INTEGER                         :: use_envelope !< enable vicosity envelope
 
  CONTAINS
 
    PROCEDURE :: initsources_base
    procedure(initsources),     DEFERRED :: initsources
    procedure(externalsources), DEFERRED :: externalsources
    procedure(calctimestep),    DEFERRED :: calctimestep
    PROCEDURE :: getsourcespointer
  END TYPE sources_base
  abstract INTERFACE
    SUBROUTINE initsources(this,Mesh,Physics,Fluxes,config,IO)
      IMPORT sources_base, mesh_base, physics_base, fluxes_base, marray_compound, dict_typ
      IMPLICIT NONE
      CLASS(sources_base), INTENT(INOUT) :: this
      CLASS(mesh_base),    INTENT(IN)    :: Mesh
      CLASS(physics_base), INTENT(IN)    :: Physics
      CLASS(fluxes_base),  INTENT(IN)    :: Fluxes
      TYPE(dict_typ), POINTER            :: config, IO
    END SUBROUTINE
    SUBROUTINE calctimestep(this,Mesh,Physics,Fluxes,pvar,cvar,time,dt,dtcause)
      IMPORT sources_base, mesh_base, physics_base, fluxes_base, marray_compound
      IMPLICIT NONE
      !------------------------------------------------------------------------!
      CLASS(sources_base),INTENT(INOUT)   :: this
      CLASS(mesh_base),INTENT(IN)         :: Mesh
      CLASS(physics_base),INTENT(INOUT)   :: Physics
      CLASS(fluxes_base),INTENT(IN)       :: Fluxes
      CLASS(marray_compound),INTENT(INOUT):: pvar,cvar
      REAL,INTENT(IN)                     :: time
      REAL, INTENT(INOUT)                 :: dt
      INTEGER, INTENT(OUT)                :: dtcause
    END SUBROUTINE
    SUBROUTINE externalsources(this,Mesh,Physics,Fluxes,Sources,time,dt,pvar,cvar,sterm)
      IMPORT sources_base, mesh_base, physics_base, fluxes_base, marray_compound
      IMPLICIT NONE
      !------------------------------------------------------------------------!
      CLASS(sources_base),INTENT(INOUT)  :: this
      CLASS(mesh_base),INTENT(IN)        :: Mesh
      CLASS(physics_base),INTENT(INOUT)  :: Physics
      CLASS(fluxes_base),INTENT(IN)      :: Fluxes
      CLASS(sources_base), INTENT(INOUT) :: Sources
      REAL,INTENT(IN)                    :: time, dt
      CLASS(marray_compound),INTENT(INOUT):: pvar,cvar,sterm
    END SUBROUTINE
    SUBROUTINE finalize(this)
      IMPORT sources_base
      IMPLICIT NONE
      !------------------------------------------------------------------------!
      CLASS(sources_base),INTENT(INOUT) :: this
    END SUBROUTINE
  END INTERFACE
  !--------------------------------------------------------------------------!
  PUBLIC :: &
       ! types
       sources_base
  !--------------------------------------------------------------------------!
 
CONTAINS
 
  SUBROUTINE initsources_base(this,stype,sname)
    IMPLICIT NONE
    !------------------------------------------------------------------------!
    CLASS(sources_base), INTENT(INOUT) :: this
    INTEGER,             INTENT(IN)    :: stype
    CHARACTER(LEN=*),    INTENT(IN)    :: sname
    !------------------------------------------------------------------------!
    IF (this%Initialized()) &
      CALL this%Error("sources_base::InitSources_base","source term already initialized")
    CALL this%InitLogging(stype,sname)
    CALL this%Info(" SOURCES--> source term:       " // this%GetName())
!     CALL this%InfoSources(Mesh)
  END SUBROUTINE initsources_base
 
 
  FUNCTION getsourcespointer(this,stype) RESULT(sp)
    IMPLICIT NONE
    !------------------------------------------------------------------------!
    CLASS(sources_base), TARGET, INTENT(IN) :: this
    CLASS(sources_base), POINTER    :: sp
    INTEGER, INTENT(IN)             :: stype
    !------------------------------------------------------------------------!
    sp => this
    DO WHILE (ASSOCIATED(sp))
!CDIR IEXPAND
      IF (sp%GetType().EQ.stype) EXIT
      sp => sp%next
    END DO
  END FUNCTION getsourcespointer
 
 
!   !> Destructor
!   SUBROUTINE Finalize_base(this)
!     IMPLICIT NONE
!     !------------------------------------------------------------------------!
!     CLASS(sources_base), INTENT(INOUT) :: this
!     !------------------------------------------------------------------------!
!     IF (.NOT.this%Initialized()) &
!       CALL this%Error("sources_base::Finalize_base"," called for uninitialized sources")
!     IF(ASSOCIATED(temp_sterm)) DEALLOCATE(temp_sterm)
!   END SUBROUTINE Finalize_base
 
END MODULE sources_base_mod