Neko  0.9.99
A portable framework for high-order spectral element flow simulations
adv_dummy.f90
Go to the documentation of this file.
1 ! Copyright (c) 2024, The Neko Authors
2 ! All rights reserved.
3 !
4 ! Redistribution and use in source and binary forms, with or without
5 ! modification, are permitted provided that the following conditions
6 ! are met:
7 !
8 ! * Redistributions of source code must retain the above copyright
9 ! notice, this list of conditions and the following disclaimer.
10 !
11 ! * Redistributions in binary form must reproduce the above
12 ! copyright notice, this list of conditions and the following
13 ! disclaimer in the documentation and/or other materials provided
14 ! with the distribution.
15 !
16 ! * Neither the name of the authors nor the names of its
17 ! contributors may be used to endorse or promote products derived
18 ! from this software without specific prior written permission.
19 !
20 ! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 ! "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 ! LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 ! FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 ! COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 ! INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 ! BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 ! LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 ! CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 ! LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 ! ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 ! POSSIBILITY OF SUCH DAMAGE.
32 !
34 module adv_dummy
35  use advection, only: advection_t
36  use num_types, only: rp
37  use space, only: space_t
38  use field, only: field_t
39  use coefs, only: coef_t
40  implicit none
41  private
42 
44  type, public, extends(advection_t) :: adv_dummy_t
45  contains
47  procedure, pass(this) :: init => init_adv_dummy
49  procedure, pass(this) :: free => free_adv_dummy
52  procedure, pass(this) :: compute => compute_adv_dummy
55  procedure, pass(this) :: compute_scalar => &
57  end type adv_dummy_t
58 
59 contains
60 
63  subroutine init_adv_dummy(this, coef)
64  class(adv_dummy_t), intent(inout) :: this
65  type(coef_t), intent(in) :: coef
66 
67  end subroutine init_adv_dummy
68 
70  subroutine free_adv_dummy(this)
71  class(adv_dummy_t), intent(inout) :: this
72 
73  end subroutine free_adv_dummy
74 
88  subroutine compute_adv_dummy(this, vx, vy, vz, fx, fy, fz, Xh, &
89  coef, n, dt)
90  class(adv_dummy_t), intent(inout) :: this
91  type(space_t), intent(inout) :: Xh
92  type(coef_t), intent(inout) :: coef
93  type(field_t), intent(inout) :: vx, vy, vz
94  type(field_t), intent(inout) :: fx, fy, fz
95  integer, intent(in) :: n
96  real(kind=rp), intent(in), optional :: dt
97 
98  end subroutine compute_adv_dummy
99 
113  subroutine compute_scalar_adv_dummy(this, vx, vy, vz, s, fs, Xh, &
114  coef, n, dt)
115  class(adv_dummy_t), intent(inout) :: this
116  type(field_t), intent(inout) :: vx, vy, vz
117  type(field_t), intent(inout) :: s
118  type(field_t), intent(inout) :: fs
119  type(space_t), intent(inout) :: Xh
120  type(coef_t), intent(inout) :: coef
121  integer, intent(in) :: n
122  real(kind=rp), intent(in), optional :: dt
123 
124  end subroutine compute_scalar_adv_dummy
125 
126 end module adv_dummy
Implements adv_dummy_t
Definition: adv_dummy.f90:34
subroutine free_adv_dummy(this)
Destructor.
Definition: adv_dummy.f90:71
subroutine compute_scalar_adv_dummy(this, vx, vy, vz, s, fs, Xh, coef, n, dt)
Add the advection term for a scalar, i.e. , to the RHS.
Definition: adv_dummy.f90:115
subroutine init_adv_dummy(this, coef)
Constructor.
Definition: adv_dummy.f90:64
subroutine compute_adv_dummy(this, vx, vy, vz, fx, fy, fz, Xh, coef, n, dt)
Add the advection term for the fluid, i.e. to the RHS.
Definition: adv_dummy.f90:90
Subroutines to add advection terms to the RHS of a transport equation.
Definition: advection.f90:34
Coefficients.
Definition: coef.f90:34
Defines a field.
Definition: field.f90:34
integer, parameter, public rp
Global precision used in computations.
Definition: num_types.f90:12
Defines a function space.
Definition: space.f90:34
A zero-valued advection that can be used to kill the advection term.
Definition: adv_dummy.f90:44
Base abstract type for computing the advection operator.
Definition: advection.f90:46
Coefficients defined on a given (mesh, ) tuple. Arrays use indices (i,j,k,e): element e,...
Definition: coef.f90:55
The function space for the SEM solution fields.
Definition: space.f90:62