class_pde.f90 Source File


This file depends on

sourcefile~~class_pde.f90~~EfferentGraph sourcefile~class_pde.f90 class_pde.f90 sourcefile~class_dimensions.f90 class_dimensions.f90 sourcefile~class_pde.f90->sourcefile~class_dimensions.f90 sourcefile~class_psblas.f90 class_psblas.f90 sourcefile~class_pde.f90->sourcefile~class_psblas.f90 sourcefile~class_mesh.f90 class_mesh.F90 sourcefile~class_pde.f90->sourcefile~class_mesh.f90 sourcefile~class_dimensions.f90->sourcefile~class_psblas.f90 sourcefile~tools_psblas.f90 tools_psblas.f90 sourcefile~class_psblas.f90->sourcefile~tools_psblas.f90 sourcefile~class_stopwatch.f90 class_stopwatch.f90 sourcefile~class_psblas.f90->sourcefile~class_stopwatch.f90 sourcefile~class_mesh.f90->sourcefile~class_psblas.f90 sourcefile~class_cell.f90 class_cell.F90 sourcefile~class_mesh.f90->sourcefile~class_cell.f90 sourcefile~class_face.f90 class_face.F90 sourcefile~class_mesh.f90->sourcefile~class_face.f90 sourcefile~class_connectivity.f90 class_connectivity.f90 sourcefile~class_mesh.f90->sourcefile~class_connectivity.f90 sourcefile~class_surface.f90 class_surface.f90 sourcefile~class_mesh.f90->sourcefile~class_surface.f90 sourcefile~class_vector.f90 class_vector.f90 sourcefile~class_mesh.f90->sourcefile~class_vector.f90 sourcefile~class_least_squares.f90 class_least_squares.f90 sourcefile~class_mesh.f90->sourcefile~class_least_squares.f90 sourcefile~class_vertex.f90 class_vertex.f90 sourcefile~class_mesh.f90->sourcefile~class_vertex.f90 sourcefile~grid_interface.f90 grid_interface.F90 sourcefile~class_mesh.f90->sourcefile~grid_interface.f90 sourcefile~class_keytable.f90 class_keytable.f90 sourcefile~class_mesh.f90->sourcefile~class_keytable.f90 sourcefile~class_cell.f90->sourcefile~class_psblas.f90 sourcefile~class_face.f90->sourcefile~class_psblas.f90 sourcefile~class_connectivity.f90->sourcefile~class_psblas.f90 sourcefile~class_surface.f90->sourcefile~class_connectivity.f90 sourcefile~class_cylinder.f90 class_cylinder.f90 sourcefile~class_surface.f90->sourcefile~class_cylinder.f90 sourcefile~class_plane.f90 class_plane.f90 sourcefile~class_surface.f90->sourcefile~class_plane.f90 sourcefile~class_vector.f90->sourcefile~class_psblas.f90 sourcefile~class_least_squares.f90->sourcefile~class_psblas.f90 sourcefile~class_least_squares.f90->sourcefile~class_connectivity.f90 sourcefile~class_vertex.f90->sourcefile~class_psblas.f90 sourcefile~class_vertex.f90->sourcefile~class_vector.f90 sourcefile~object_interface.f90 object_interface.f90 sourcefile~grid_interface.f90->sourcefile~object_interface.f90 sourcefile~units_interface.f90 units_interface.F90 sourcefile~grid_interface.f90->sourcefile~units_interface.f90 sourcefile~class_stopwatch.f90->sourcefile~tools_psblas.f90 sourcefile~units_interface.f90->sourcefile~object_interface.f90 sourcefile~class_cylinder.f90->sourcefile~class_psblas.f90 sourcefile~class_cylinder.f90->sourcefile~class_vector.f90 sourcefile~class_cylinder.f90->sourcefile~class_vertex.f90 sourcefile~class_plane.f90->sourcefile~class_psblas.f90 sourcefile~class_plane.f90->sourcefile~class_vector.f90

Files dependent on this one

sourcefile~~class_pde.f90~~AfferentGraph sourcefile~class_pde.f90 class_pde.f90 sourcefile~class_pde_procedures.f90 class_pde_procedures.f90 sourcefile~class_pde_procedures.f90->sourcefile~class_pde.f90 sourcefile~class_vector_pde.f90 class_vector_pde.f90 sourcefile~class_vector_pde.f90->sourcefile~class_pde.f90 sourcefile~class_scalar_pde.f90 class_scalar_pde.f90 sourcefile~class_scalar_pde.f90->sourcefile~class_pde.f90 sourcefile~class_vector_pde_procedures.f90 class_vector_pde_procedures.f90 sourcefile~class_vector_pde_procedures.f90->sourcefile~class_pde.f90 sourcefile~class_vector_pde_procedures.f90->sourcefile~class_vector_pde.f90 sourcefile~op_div.f90 op_div.f90 sourcefile~op_div.f90->sourcefile~class_vector_pde.f90 sourcefile~op_div.f90->sourcefile~class_scalar_pde.f90 sourcefile~op_grad.f90 op_grad.f90 sourcefile~op_grad.f90->sourcefile~class_vector_pde.f90 sourcefile~op_laplacian.f90 op_laplacian.f90 sourcefile~op_laplacian.f90->sourcefile~class_vector_pde.f90 sourcefile~op_laplacian.f90->sourcefile~class_scalar_pde.f90 sourcefile~vector_pde_laplacian.f90 vector_pde_laplacian.f90 sourcefile~vector_pde_laplacian.f90->sourcefile~class_vector_pde.f90 sourcefile~vector_pde_laplacian.f90->sourcefile~op_grad.f90 sourcefile~vector_pde_laplacian.f90->sourcefile~op_laplacian.f90 sourcefile~vector_pde_grad.f90 vector_pde_grad.f90 sourcefile~vector_pde_grad.f90->sourcefile~class_vector_pde.f90 sourcefile~vector_pde_grad.f90->sourcefile~op_grad.f90 sourcefile~vector_pde_div.f90 vector_pde_div.f90 sourcefile~vector_pde_div.f90->sourcefile~class_vector_pde.f90 sourcefile~vector_pde_div.f90->sourcefile~op_div.f90 sourcefile~vector_pde_source.f90 vector_pde_source.f90 sourcefile~vector_pde_source.f90->sourcefile~class_vector_pde.f90 sourcefile~vector_pde_source.f90->sourcefile~class_scalar_pde.f90 sourcefile~tools_nemo.f90 tools_nemo.f90 sourcefile~tools_nemo.f90->sourcefile~class_vector_pde.f90 sourcefile~tools_nemo.f90->sourcefile~class_scalar_pde.f90 sourcefile~tools_nemo.f90->sourcefile~op_div.f90 sourcefile~tools_nemo.f90->sourcefile~op_grad.f90 sourcefile~tools_nemo.f90->sourcefile~op_laplacian.f90 sourcefile~op_source.f90 op_source.f90 sourcefile~tools_nemo.f90->sourcefile~op_source.f90 sourcefile~op_ddt.f90 op_ddt.f90 sourcefile~tools_nemo.f90->sourcefile~op_ddt.f90 sourcefile~op_d2dt2.f90 op_d2dt2.f90 sourcefile~tools_nemo.f90->sourcefile~op_d2dt2.f90 sourcefile~class_scalar_pde_procedures.f90 class_scalar_pde_procedures.f90 sourcefile~class_scalar_pde_procedures.f90->sourcefile~class_scalar_pde.f90 sourcefile~vector_pde_d2dt2.f90 vector_pde_d2dt2.f90 sourcefile~vector_pde_d2dt2.f90->sourcefile~class_vector_pde.f90 sourcefile~vector_pde_d2dt2.f90->sourcefile~op_d2dt2.f90 sourcefile~op_source.f90->sourcefile~class_scalar_pde.f90 sourcefile~vector_pde_ddt.f90 vector_pde_ddt.f90 sourcefile~vector_pde_ddt.f90->sourcefile~class_vector_pde.f90 sourcefile~vector_pde_ddt.f90->sourcefile~op_ddt.f90 sourcefile~op_ddt.f90->sourcefile~class_vector_pde.f90 sourcefile~op_ddt.f90->sourcefile~class_scalar_pde.f90 sourcefile~op_d2dt2.f90->sourcefile~class_vector_pde.f90 sourcefile~op_d2dt2.f90->sourcefile~class_scalar_pde.f90 sourcefile~scalar_field_grad.f90 scalar_field_grad.f90 sourcefile~scalar_field_grad.f90->sourcefile~op_grad.f90 sourcefile~op_ddt_procedures.f90 op_ddt_procedures.f90 sourcefile~op_ddt_procedures.f90->sourcefile~op_ddt.f90 sourcefile~scalar_pde_d2dt2.f90 scalar_pde_d2dt2.f90 sourcefile~scalar_pde_d2dt2.f90->sourcefile~op_d2dt2.f90 sourcefile~scalar_pde_laplacian.f90 scalar_pde_laplacian.f90 sourcefile~scalar_pde_laplacian.f90->sourcefile~op_grad.f90 sourcefile~scalar_pde_laplacian.f90->sourcefile~op_laplacian.f90 sourcefile~vector_field_grad.f90 vector_field_grad.f90 sourcefile~vector_field_grad.f90->sourcefile~op_grad.f90 sourcefile~op_d2dt2_procedures.f90 op_d2dt2_procedures.f90 sourcefile~op_d2dt2_procedures.f90->sourcefile~op_d2dt2.f90 sourcefile~op_laplacian_procedures.f90 op_laplacian_procedures.f90 sourcefile~op_laplacian_procedures.f90->sourcefile~op_laplacian.f90 sourcefile~flux_pde_div.f90 flux_pde_div.f90 sourcefile~flux_pde_div.f90->sourcefile~op_div.f90 sourcefile~scalar_pde_ddt.f90 scalar_pde_ddt.f90 sourcefile~scalar_pde_ddt.f90->sourcefile~op_ddt.f90 sourcefile~scalar_pde_div.f90 scalar_pde_div.f90 sourcefile~scalar_pde_div.f90->sourcefile~op_div.f90 sourcefile~scalar_pde_source.f90 scalar_pde_source.f90 sourcefile~scalar_pde_source.f90->sourcefile~op_source.f90

Contents

Source Code


Source Code

!
!     (c) 2019 Guide Star Engineering, LLC
!     This Software was developed for the US Nuclear Regulatory Commission (US NRC)
!     under contract "Multi-Dimensional Physics Implementation into Fuel Analysis under
!     Steady-state and Transients (FAST)", contract # NRC-HQ-60-17-C-0007
!
!
!    NEMO - Numerical Engine (for) Multiphysics Operators
! Copyright (c) 2007, Stefano Toninel
!                     Gian Marco Bianchi  University of Bologna
!              David P. Schmidt    University of Massachusetts - Amherst
!              Salvatore Filippone University of Rome Tor Vergata
! All rights reserved.
!
! Redistribution and use in source and binary forms, with or without modification,
! are permitted provided that the following conditions are met:
!
!     1. Redistributions of source code must retain the above copyright notice,
!        this list of conditions and the following disclaimer.
!     2. Redistributions in binary form must reproduce the above copyright notice,
!        this list of conditions and the following disclaimer in the documentation
!        and/or other materials provided with the distribution.
!     3. Neither the name of the NEMO project nor the names of its contributors
!        may be used to endorse or promote products derived from this software
!        without specific prior written permission.
!
! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
! ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
! WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
! DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
! ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
! (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
! LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
! ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
! (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
! SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
!
!---------------------------------------------------------------------------------
!
! $Id: class_pde.f90 9102 2015-04-24 16:06:49Z sfilippo $
!
! Description:
!    To be added...
!
MODULE class_pde

    USE class_psblas
    USE class_dimensions
    USE class_mesh

    IMPLICIT NONE

    PRIVATE ! Default
    PUBLIC :: pde                            !! Class

    TYPE pde
        PRIVATE
        CHARACTER(len=32) :: name               !! Name
        TYPE(dimensions) :: dim                 !! Dimensions
        TYPE(mesh), POINTER :: msh => NULL()    !! Mesh
        TYPE(psb_dspmat_type) :: A              !! PSBLAS
        REAL(psb_dpk_), ALLOCATABLE :: diag(:)  !! A's diag
        ! Linear System
        TYPE(psb_dprec_type) :: prec
        CHARACTER(len=10) :: cmethod
        CHARACTER(len=10) :: cprec
        INTEGER :: nlev
        REAL(psb_dpk_) :: eps_solv
        INTEGER :: itmax_solv
        LOGICAL :: mtx_sys
        ! Status
        INTEGER :: status
    CONTAINS
        PROCEDURE, PUBLIC :: create_pde                     !! Constructor
        PROCEDURE, PUBLIC, PASS(eqn) :: spins_pde           !! Linear System Solving
        PROCEDURE, PUBLIC :: free_pde                       !! Destructor
        PROCEDURE, PUBLIC :: write_pde
        PROCEDURE, PRIVATE :: get_pde_dim, get_pde_msh_fun  !! Getter
        GENERIC, PUBLIC :: dim_ => get_pde_dim
        GENERIC, PUBLIC :: msh_ => get_pde_msh_fun
        PROCEDURE, PRIVATE :: get_pde_diag, update_pde_diag !! Getter & Setter
        GENERIC, PUBLIC :: get_diag => get_pde_diag
        PROCEDURE, PRIVATE :: get_pde_A                     !! Getter
        GENERIC, PUBLIC :: get_A => get_pde_A
        GENERIC, PUBLIC :: update_diag => update_pde_diag
        PROCEDURE :: is_pde_bld, is_pde_asb                 !! Status inquirer
        PROCEDURE :: free_pde_prec, build_pde_prec
        PROCEDURE :: solve_pde_sys, reinit_pde
        PROCEDURE, PRIVATE :: get_pde_name
        GENERIC, PUBLIC :: name_ => get_pde_name
        PROCEDURE, PUBLIC :: nemo_sizeof
        PROCEDURE, PRIVATE :: get_pde_msh_sub
        GENERIC, PUBLIC :: get_mesh => get_pde_msh_sub
        PROCEDURE, PUBLIC :: asb_pde_
    END TYPE pde

    INTERFACE

        MODULE FUNCTION nemo_sizeof(eqn)
            USE class_psblas
            IMPLICIT NONE
            CLASS(pde), INTENT(IN) :: eqn
            INTEGER(kind=nemo_int_long_)   :: nemo_sizeof
        END FUNCTION nemo_sizeof

        !! Constructor

        MODULE SUBROUTINE create_pde(eqn,input_file,sec,msh,dim)
            USE class_connectivity
            USE tools_input
            IMPLICIT NONE
            CLASS(pde),       INTENT(OUT)           :: eqn
            CHARACTER(len=*), INTENT(IN)            :: input_file
            CHARACTER(len=*), INTENT(IN)            :: sec
            TYPE(mesh),       INTENT(INOUT), TARGET :: msh
            TYPE(dimensions), INTENT(IN)            :: dim
        END SUBROUTINE create_pde

        !! ----- Destructor -----

        MODULE SUBROUTINE free_pde(eqn)
            !!  Destructor
            IMPLICIT NONE
            CLASS(pde), INTENT(INOUT) :: eqn
        END SUBROUTINE free_pde

        !! ----- Getters -----

        MODULE FUNCTION get_pde_name(eqn)
            IMPLICIT NONE
            CLASS(pde), INTENT(IN) :: eqn
            CHARACTER(len=32) :: get_pde_name
        END FUNCTION get_pde_name

        MODULE FUNCTION get_pde_dim(eqn)
            IMPLICIT NONE
            CLASS(pde), INTENT(IN) :: eqn
            TYPE(dimensions) :: get_pde_dim
        END FUNCTION get_pde_dim

        MODULE SUBROUTINE get_pde_A(eqn,B)
            IMPLICIT NONE
            CLASS(pde), INTENT(INOUT) :: eqn
            TYPE(psb_dspmat_type)     :: B
        END SUBROUTINE get_pde_A

        MODULE FUNCTION get_pde_msh_fun(eqn)
            IMPLICIT NONE
            CLASS(pde), INTENT(IN) :: eqn
            TYPE(mesh), POINTER    :: get_pde_msh_fun
        END FUNCTION get_pde_msh_fun

        MODULE SUBROUTINE get_pde_diag(eqn,d)
            IMPLICIT NONE
            CLASS(pde),     INTENT(INOUT) :: eqn
            REAL(psb_dpk_), ALLOCATABLE   :: d(:)
        END SUBROUTINE get_pde_diag

        MODULE SUBROUTINE update_pde_diag(eqn)
            IMPLICIT NONE
            CLASS(pde), INTENT(INOUT) :: eqn
        END SUBROUTINE update_pde_diag

        !! ----- Temporary up to Gfortran patch -----
        MODULE SUBROUTINE get_pde_msh_sub(eqn,msh)
            IMPLICIT NONE
            CLASS(pde), INTENT(IN) :: eqn
            TYPE(mesh), POINTER    :: msh
        END SUBROUTINE get_pde_msh_sub

        MODULE SUBROUTINE asb_pde_(eqn)
            IMPLICIT NONE
            CLASS(pde), INTENT(INOUT) :: eqn
        END SUBROUTINE asb_pde_

        MODULE SUBROUTINE reinit_pde(eqn)
            IMPLICIT NONE
            CLASS(pde), INTENT(INOUT) :: eqn
        END SUBROUTINE reinit_pde

        !! ----- Output -----

        MODULE SUBROUTINE write_pde(eqn,mat,mtx_rhs)
            !! Output
            USE tools_output_basics
            IMPLICIT NONE
            CLASS(pde),       INTENT(IN)  :: eqn
            CHARACTER(len=*), INTENT(IN)  :: mat
            LOGICAL,          INTENT(OUT) :: mtx_rhs
        END SUBROUTINE write_pde

        !! ----- Status Inquirer -----

        MODULE FUNCTION is_pde_bld(eqn)
            IMPLICIT NONE
            CLASS(pde), INTENT(IN) :: eqn
            LOGICAL :: is_pde_bld
        END FUNCTION is_pde_bld

        MODULE FUNCTION is_pde_asb(eqn)
            IMPLICIT NONE
            CLASS(pde), INTENT(IN) :: eqn
            LOGICAL :: is_pde_asb
        END FUNCTION is_pde_asb

        MODULE SUBROUTINE build_pde_prec(eqn)
            IMPLICIT NONE
            CLASS(pde), INTENT(INOUT) :: eqn
        END SUBROUTINE build_pde_prec

        MODULE SUBROUTINE free_pde_prec(eqn)
            IMPLICIT NONE
            CLASS(pde), INTENT(INOUT) :: eqn
        END SUBROUTINE free_pde_prec

        MODULE SUBROUTINE solve_pde_sys(eqn,b,x,iter,err)
            IMPLICIT NONE
            CLASS(pde),     INTENT(INOUT) :: eqn
            REAL(psb_dpk_), INTENT(IN)    :: b(:)
            REAL(psb_dpk_), INTENT(OUT)   :: x(:)
            INTEGER,        INTENT(OUT)   :: iter
            REAL(psb_dpk_), INTENT(OUT)   :: err
        END SUBROUTINE solve_pde_sys

        !! ----- Linear System Solving -----

        MODULE SUBROUTINE spins_pde(n,ia,ja,cloud,eqn)
            !! Linear System Solving
            !! Inserts a ``cloud'' of coefficients into eqn%A
            IMPLICIT NONE
            INTEGER,        INTENT(IN)    :: n
            INTEGER,        INTENT(IN)    :: ia(:), ja(:)
            REAL(psb_dpk_), INTENT(IN)    :: cloud(:)
            CLASS(pde),     INTENT(INOUT) :: eqn
        END SUBROUTINE spins_pde

    END INTERFACE

END MODULE class_pde