Neko-TOP
A portable framework for high-order spectral element flow toplogy optimization.
Loading...
Searching...
No Matches
simple_brinkman_source_term.f90
1! Copyright (c) 2023, 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! a term in the form $\chi \mathbf{u}$
36 use num_types, only: rp
37 use field_list, only: field_list_t
38 use json_module, only: json_file
39 use json_utils, only: json_get, json_get_or_default
40 use source_term, only: source_term_t
41 use coefs, only: coef_t
42 use neko_config, only: neko_bcknd_device
43 use time_state, only: time_state_t
44 use utils, only: neko_error
45 use field, only: field_t
46 use field_math, only: field_subcol3
47 implicit none
48 private
49
51 ! We have a source term of the form $\chi \mathbf{u}$
52 type, public, extends(source_term_t) :: simple_brinkman_source_term_t
54 type(field_t), pointer :: chi => null()
56 type(field_t), pointer :: u => null()
58 type(field_t), pointer :: v => null()
60 type(field_t), pointer :: w => null()
61
62 contains
64 procedure, pass(this) :: init => &
65 simple_brinkman_source_term_init_from_json
67 procedure, pass(this) :: init_from_components => &
68 simple_brinkman_source_term_init_from_components
70 procedure, pass(this) :: free => simple_brinkman_source_term_free
72 procedure, pass(this) :: compute_ => simple_brinkman_source_term_compute
74
75contains
82 subroutine simple_brinkman_source_term_init_from_json(this, json, fields, &
83 coef, variable_name)
84 class(simple_brinkman_source_term_t), intent(inout) :: this
85 type(json_file), intent(inout) :: json
86 type(field_list_t), intent(in), target :: fields
87 type(coef_t), intent(in), target :: coef
88 character(len=*), intent(in) :: variable_name
89
90
91 ! we shouldn't be initializing this from JSON
92 ! maybe throw an error?
93
94
95 end subroutine simple_brinkman_source_term_init_from_json
96
103 subroutine simple_brinkman_source_term_init_from_components(this, &
104 f_x, f_y, f_z, chi, u, v, w, coef)
105 class(simple_brinkman_source_term_t), intent(inout) :: this
106 type(field_t), pointer, intent(in) :: f_x, f_y, f_z
107 type(field_list_t) :: fields
108 type(coef_t) :: coef
109 real(kind=rp) :: start_time
110 real(kind=rp) :: end_time
111 type(field_t), intent(in), target :: u, v, w
112 type(field_t), intent(in), target :: chi
113
114 ! I wish you didn't need a start time and end time...
115 ! but I'm just going to set a super big number...
116 start_time = 0.0_rp
117 end_time = 100000000.0_rp
118
119 call this%free()
120
121 ! this is copying the fluid source term init
122 ! We package the fields for the source term to operate on in a field list.
123 call fields%init(3)
124 call fields%assign(1, f_x)
125 call fields%assign(2, f_y)
126 call fields%assign(3, f_z)
127
128 call this%init_base(fields, coef, start_time, end_time)
129
130 ! point everything in the correct places
131 this%u => u
132 this%v => v
133 this%w => w
134 ! and get chi out of the design
135 this%chi => chi
136
137 end subroutine simple_brinkman_source_term_init_from_components
138
140 subroutine simple_brinkman_source_term_free(this)
141 class(simple_brinkman_source_term_t), intent(inout) :: this
142
143 call this%free_base()
144 end subroutine simple_brinkman_source_term_free
145
149 subroutine simple_brinkman_source_term_compute(this, time)
150 class(simple_brinkman_source_term_t), intent(inout) :: this
151 type(time_state_t), intent(in) :: time
152 type(field_t), pointer :: fu, fv, fw
153
154 fu => this%fields%get_by_index(1)
155 fv => this%fields%get_by_index(2)
156 fw => this%fields%get_by_index(3)
157
158 call field_subcol3(fu, this%u, this%chi)
159 call field_subcol3(fv, this%v, this%chi)
160 call field_subcol3(fw, this%w, this%chi)
161
162 end subroutine simple_brinkman_source_term_compute
163
Implements the simple_brinkman_source_term_t type.