Neko  0.9.99
A portable framework for high-order spectral element flow simulations
mean_flow.f90
Go to the documentation of this file.
1 ! Copyright (c) 2021, 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 mean_flow
35  use mean_field, only : mean_field_t
36  use field, only : field_t
37  implicit none
38  private
39 
40  type, public :: mean_flow_t
41  type(mean_field_t) :: u
42  type(mean_field_t) :: v
43  type(mean_field_t) :: w
44  type(mean_field_t) :: p
45  contains
46  procedure, pass(this) :: init => mean_flow_init
47  procedure, pass(this) :: free => mean_flow_free
48  procedure, pass(this) :: reset => mean_flow_reset
49  end type mean_flow_t
50 
51 contains
52 
54  subroutine mean_flow_init(this, u, v, w, p)
55  class(mean_flow_t), intent(inout) :: this
56  type(field_t), target, intent(inout) :: u
57  type(field_t), target, intent(inout) :: v
58  type(field_t), target, intent(inout) :: w
59  type(field_t), target, intent(inout) :: p
60 
61  call this%free()
62 
63  call this%u%init(u)
64  call this%v%init(v)
65  call this%w%init(w)
66  call this%p%init(p)
67 
68  end subroutine mean_flow_init
69 
70 
72  subroutine mean_flow_free(this)
73  class(mean_flow_t), intent(inout) :: this
74 
75  call this%u%free()
76  call this%v%free()
77  call this%w%free()
78  call this%p%free()
79 
80  end subroutine mean_flow_free
81 
83  subroutine mean_flow_reset(this)
84  class(mean_flow_t), intent(inout) :: this
85 
86  call this%u%reset()
87  call this%v%reset()
88  call this%w%reset()
89  call this%p%reset()
90 
91  end subroutine mean_flow_reset
92 
93 end module mean_flow
Defines a field.
Definition: field.f90:34
Implements mean_field_t.
Definition: mean_field.f90:35
Defines a mean flow field.
Definition: mean_flow.f90:34
subroutine mean_flow_init(this, u, v, w, p)
Initialize a mean flow field.
Definition: mean_flow.f90:55
subroutine mean_flow_free(this)
Deallocates a mean flow field.
Definition: mean_flow.f90:73
subroutine mean_flow_reset(this)
Resets a mean flow field.
Definition: mean_flow.f90:84
Computes the temporal mean of a field.
Definition: mean_field.f90:45