params_multigrid_setup_t Derived Type

type, public :: params_multigrid_setup_t

Parameters for multigrid_setup


Contents

Type-Bound Procedures


Type-Bound Procedures

procedure, public :: set => set_parameters_multigrid_setup

  • private subroutine set_parameters_multigrid_setup(self, filename, spacing_f_in, nlvls_in, size_neighbor_in, size_ghost_layer_in, reorder_size_in, extend_beyond_wall_in)

    Sets parameters for multigrid_setup, either via namelist from file, or setting explicitly

    Arguments

    Type IntentOptional Attributes Name
    class(params_multigrid_setup_t), intent(inout) :: self

    Instance of the type

    character(len=*), intent(in), optional :: filename

    Filename where parameter are read from
    real(kind=GP), intent(in), optional :: spacing_f_in

    Mesh spacing on finest level

    integer, intent(in), optional :: nlvls_in

    Number of multigrid levels
    integer, intent(in), optional :: size_neighbor_in

    Number of neighbor points stored
    integer, intent(in), optional :: size_ghost_layer_in

    Depth of ghost layer
    integer, intent(in), optional :: reorder_size_in

    Block size for reordering
    logical, intent(in), optional :: extend_beyond_wall_in

    Switch if mesh is extended beyond wall

procedure, public :: get_spacing_f

  • private pure function get_spacing_f(self)

    Gets mesh spacing on finest level

    Arguments

    Type IntentOptional Attributes Name
    class(params_multigrid_setup_t), intent(in) :: self

    Instance of the type

    Return Value real(kind=gp)

procedure, public :: get_nlvls

  • private pure function get_nlvls(self)

    Gets number of multigrid levels

    Arguments

    Type IntentOptional Attributes Name
    class(params_multigrid_setup_t), intent(in) :: self

    Instance of the type

    Return Value integer

procedure, public :: get_size_neighbor

  • private pure function get_size_neighbor(self)

    Gets size_neighbor

    Arguments

    Type IntentOptional Attributes Name
    class(params_multigrid_setup_t), intent(in) :: self

    Instance of the type

    Return Value integer

procedure, public :: get_size_ghost_layer

  • private pure function get_size_ghost_layer(self)

    Gets size_ghost_layer

    Arguments

    Type IntentOptional Attributes Name
    class(params_multigrid_setup_t), intent(in) :: self

    Instance of the type

    Return Value integer

procedure, public :: get_reorder_size

  • private pure function get_reorder_size(self)

    Gets reorder

    Arguments

    Type IntentOptional Attributes Name
    class(params_multigrid_setup_t), intent(in) :: self

    Instance of the type

    Return Value integer

procedure, public :: get_extend_beyond_wall

  • private function get_extend_beyond_wall(self)

    Gets reorder

    Arguments

    Type IntentOptional Attributes Name
    class(params_multigrid_setup_t), intent(in) :: self

    Instance of the type

    Return Value logical

procedure, public :: display => display_parameters_multigrid_setup

  • private subroutine display_parameters_multigrid_setup(self)

    Displays information about parameters

    Arguments

    Type IntentOptional Attributes Name
    class(params_multigrid_setup_t), intent(in) :: self

    Instance of the type