class_field_procedures.f90 Source File


This file depends on

sourcefile~~class_field_procedures.f90~~EfferentGraph sourcefile~class_field_procedures.f90 class_field_procedures.f90 sourcefile~class_mesh.f90 class_mesh.F90 sourcefile~class_field_procedures.f90->sourcefile~class_mesh.f90 sourcefile~class_material.f90 class_material.f90 sourcefile~class_field_procedures.f90->sourcefile~class_material.f90 sourcefile~class_psblas.f90 class_psblas.f90 sourcefile~class_field_procedures.f90->sourcefile~class_psblas.f90 sourcefile~class_field.f90 class_field.f90 sourcefile~class_field_procedures.f90->sourcefile~class_field.f90 sourcefile~class_dimensions.f90 class_dimensions.f90 sourcefile~class_field_procedures.f90->sourcefile~class_dimensions.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_material.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_field.f90->sourcefile~class_mesh.f90 sourcefile~class_field.f90->sourcefile~class_material.f90 sourcefile~class_field.f90->sourcefile~class_psblas.f90 sourcefile~class_field.f90->sourcefile~class_dimensions.f90 sourcefile~class_bc.f90 class_bc.f90 sourcefile~class_field.f90->sourcefile~class_bc.f90 sourcefile~class_field.f90->sourcefile~grid_interface.f90 sourcefile~class_dimensions.f90->sourcefile~class_psblas.f90 sourcefile~class_cell.f90->sourcefile~class_psblas.f90 sourcefile~class_face.f90->sourcefile~class_psblas.f90 sourcefile~class_bc.f90->sourcefile~class_psblas.f90 sourcefile~class_bc_wall.f90 class_bc_wall.f90 sourcefile~class_bc.f90->sourcefile~class_bc_wall.f90 sourcefile~class_bc_math.f90 class_bc_math.f90 sourcefile~class_bc.f90->sourcefile~class_bc_math.f90 sourcefile~class_motion.f90 class_motion.f90 sourcefile~class_bc.f90->sourcefile~class_motion.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~units_interface.f90 units_interface.F90 sourcefile~grid_interface.f90->sourcefile~units_interface.f90 sourcefile~object_interface.f90 object_interface.f90 sourcefile~grid_interface.f90->sourcefile~object_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 sourcefile~class_bc_wall.f90->sourcefile~class_mesh.f90 sourcefile~class_bc_wall.f90->sourcefile~class_material.f90 sourcefile~class_bc_wall.f90->sourcefile~class_psblas.f90 sourcefile~class_bc_wall.f90->sourcefile~class_dimensions.f90 sourcefile~class_bc_wall.f90->sourcefile~class_vector.f90 sourcefile~class_bc_wall.f90->sourcefile~class_bc_math.f90 sourcefile~class_bc_math.f90->sourcefile~class_psblas.f90 sourcefile~class_motion.f90->sourcefile~class_psblas.f90 sourcefile~class_motion.f90->sourcefile~class_vector.f90

Contents


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_field.f90 8157 2014-10-09 13:02:44Z sfilippo $
!
! Description:
!    Base class for scalar, vector and tensor field
!
SUBMODULE(class_field) class_field_procedures

    IMPLICIT NONE

CONTAINS

    MODULE PROCEDURE nemo_sizeof
        USE class_psblas, ONLY : nemo_sizeof_int
        IMPLICIT NONE

        !
        ! msh, bc and mat are independent objects.
        !
        nemo_sizeof = nemo_sizeof_int + LEN(fld%name)

    END PROCEDURE nemo_sizeof

    ! ----- Constructor -----

    MODULE PROCEDURE create_field
        USE class_dimensions, ONLY : null_dim_
        IMPLICIT NONE

        ! Assigns mandatory arguments
        fld%msh => msh

        ! Assigns optional arguments
        IF(PRESENT(dim)) THEN
            fld%dim = dim
        ELSE
            fld%dim = null_dim_
        END IF

        IF(PRESENT(bc)) THEN
            fld%bc => bc
        ELSE
            fld%bc => NULL()
        END IF

        IF(PRESENT(mats)) THEN
            fld%mats => mats
        ELSE
            fld%mats => NULL()
        END IF

        IF(PRESENT(on_faces)) THEN
            fld%on_faces = on_faces
        ELSE
            fld%on_faces = .FALSE. ! Default is cell-centered
        END IF

        ! Field name
        IF (PRESENT(name)) THEN
            fld%name = TRIM(name)
        ELSE
            fld%name = fld%dim%quantity()
        END IF

    END PROCEDURE create_field


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

    MODULE PROCEDURE free_field
        IMPLICIT NONE

        NULLIFY(fld%msh)
        NULLIFY(fld%bc)
        NULLIFY(fld%mats)
    END PROCEDURE free_field


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

    MODULE PROCEDURE name_
        IMPLICIT NONE

        name_ = fld%name

    END PROCEDURE name_


    MODULE PROCEDURE get_field_dim
        IMPLICIT NONE

        get_field_dim = fld%dim

    END PROCEDURE get_field_dim


    MODULE PROCEDURE get_mesh
        IMPLICIT NONE

        msh => fld%msh

    END PROCEDURE get_mesh

    MODULE PROCEDURE msh_
        IMPLICIT NONE

        msh_ => fld%msh

    END PROCEDURE msh_


    MODULE PROCEDURE on_faces_
        IMPLICIT NONE

        on_faces_ = fld%on_faces

    END PROCEDURE on_faces_


    MODULE PROCEDURE bc_
        IMPLICIT NONE

        bc_ => fld%bc

    END PROCEDURE bc_


    MODULE PROCEDURE get_field_mat_sub
        IMPLICIT NONE

        IF (PRESENT(i) .AND. i < SIZE(fld%mats)) THEN
            mat => fld%mats(i)%mat
        ELSE
            mat => fld%mats(1)%mat
        END IF

    END PROCEDURE get_field_mat_sub
    !
    MODULE PROCEDURE mat_
        IMPLICIT NONE

        IF (PRESENT(i) .AND. i < SIZE(fld%mats)) THEN
            mat_ => fld%mats(i)%mat
        ELSE
            mat_ => fld%mats(1)%mat
        END IF

    END PROCEDURE mat_


    MODULE PROCEDURE get_field_size
        IMPLICIT NONE

        ! Number of internal elements
        IF(fld%on_faces) THEN
            ! Face-centered
            isize(fld_internal_) = COUNT(fld%msh%faces%flag_() <= 0)
        ELSE
            ! Cell-centered
            isize(fld_internal_) = SIZE(fld%msh%cells)
        END IF

        ! Number of boundary faces
        isize(fld_boundary_) = COUNT(fld%msh%faces%flag_() > 0)

    END PROCEDURE get_field_size

    ! ----- Setter -----

    MODULE PROCEDURE set_field_dim
        IMPLICIT NONE

        fld%dim = dim

    END PROCEDURE set_field_dim

    MODULE PROCEDURE set_field_on_faces
        IMPLICIT NONE

        fld%on_faces = on_faces

    END PROCEDURE set_field_on_faces


    ! ----- Auxiliary Routines -----

    MODULE PROCEDURE check_mesh_consistency_bf
        USE class_mesh, ONLY : check_mesh_consistency
        IMPLICIT NONE

        CALL check_mesh_consistency(f1%msh,f2%msh,WHERE)

        ! bf = Base Field
    END PROCEDURE check_mesh_consistency_bf


    MODULE PROCEDURE check_field_operands
        USE class_mesh,     ONLY : check_mesh_consistency
        USE class_material, ONLY : check_material_consistency
        USE class_psblas,   ONLY : abort_psblas
        IMPLICIT NONE

        CALL check_mesh_consistency(f1%msh,f2%msh,'CHECk_FIELD_OPERANDS')

        IF (SIZE(f1%mats) /= SIZE(f2%mats)) THEN
            WRITE(*,100) TRIM(WHERE)
            CALL abort_psblas
        END IF

        CALL check_material_consistency(f1%mats,f2%mats,'CHECK_FIELD_OPERANDS')

        IF(f1%on_faces_() .AND. .NOT.(f2%on_faces_()) &
            & .OR. (f2%on_faces_() .AND. .NOT.(f1%on_faces_()))) THEN
            WRITE(*,100) TRIM(WHERE)
            CALL abort_psblas
        END IF

100     FORMAT(' ERROR! Face-centered field operand in ',a)

    END PROCEDURE check_field_operands


END SUBMODULE class_field_procedures