Loading [MathJax]/extensions/tex2jax.js
Neko 0.9.99
A portable framework for high-order spectral element flow simulations
All Classes Namespaces Files Functions Variables Typedefs Enumerator Macros Pages
vorticity.f90
Go to the documentation of this file.
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!
33!
35
37 use num_types, only : rp, dp, sp
38 use json_module, only : json_file
41 use field, only : field_t
42 use operators, only : curl
43 use case, only : case_t
47 use device, only : glb_cmd_event
48 implicit none
49 private
50
53 type, public, extends(simulation_component_t) :: vorticity_t
55 type(field_t), pointer :: u
57 type(field_t), pointer :: v
59 type(field_t), pointer :: w
60
62 type(field_t), pointer :: omega_x
64 type(field_t), pointer :: omega_y
66 type(field_t), pointer :: omega_z
67
69 type(field_t) :: temp1
71 type(field_t) :: temp2
72
74 type(field_writer_t) :: writer
75
76 contains
78 procedure, pass(this) :: init => vorticity_init_from_json
80 procedure, pass(this) :: init_from_attributes => &
83 procedure, pass(this) :: free => vorticity_free
85 procedure, pass(this) :: compute_ => vorticity_compute
86 end type vorticity_t
87
88contains
89
91 subroutine vorticity_init_from_json(this, json, case)
92 class(vorticity_t), intent(inout) :: this
93 type(json_file), intent(inout) :: json
94 class(case_t), intent(inout), target :: case
95 character(len=20) :: fields(3)
96
97 ! Add fields keyword to the json so that the field_writer picks it up.
98 ! Will also add fields to the registry.
99 fields(1) = "omega_x"
100 fields(2) = "omega_y"
101 fields(3) = "omega_z"
102
103 call json%add("fields", fields)
104
105 call this%init_base(json, case)
106 call this%writer%init(json, case)
107
109 end subroutine vorticity_init_from_json
110
113 class(vorticity_t), intent(inout) :: this
114
115 this%u => neko_field_registry%get_field_by_name("u")
116 this%v => neko_field_registry%get_field_by_name("v")
117 this%w => neko_field_registry%get_field_by_name("w")
118
119 this%omega_x => neko_field_registry%get_field_by_name("omega_x")
120 this%omega_y => neko_field_registry%get_field_by_name("omega_y")
121 this%omega_z => neko_field_registry%get_field_by_name("omega_z")
122
123 call this%temp1%init(this%u%dof)
124 call this%temp2%init(this%u%dof)
125
126 end subroutine vorticity_init_from_attributes
127
129 subroutine vorticity_free(this)
130 class(vorticity_t), intent(inout) :: this
131 call this%free_base()
132 call this%writer%free()
133 call this%temp1%free()
134 call this%temp2%free()
135
136 nullify(this%u)
137 nullify(this%v)
138 nullify(this%w)
139 nullify(this%omega_x)
140 nullify(this%omega_y)
141 nullify(this%omega_z)
142 end subroutine vorticity_free
143
147 subroutine vorticity_compute(this, t, tstep)
148 class(vorticity_t), intent(inout) :: this
149 real(kind=rp), intent(in) :: t
150 integer, intent(in) :: tstep
151
152 call curl(this%omega_x, this%omega_y, this%omega_z, this%u, this%v, &
153 this%w, this%temp1, this%temp2, this%case%fluid%c_Xh, &
155 end subroutine vorticity_compute
156
157end module vorticity
Retrieves a parameter by name or assigns a provided default value. In the latter case also adds the m...
Retrieves a parameter by name or throws an error.
Defines a simulation case.
Definition case.f90:34
Device abstraction, common interface for various accelerators.
Definition device.F90:34
type(c_ptr), bind(C), public glb_cmd_event
Event for the global command queue.
Definition device.F90:56
Defines a registry for storing solution fields.
type(field_registry_t), target, public neko_field_registry
Global field registry.
Implements the field_writer_t type.
Defines a field.
Definition field.f90:34
Implements fld_file_output_t.
Utilities for retrieving parameters from the case files.
integer, parameter, public dp
Definition num_types.f90:9
integer, parameter, public sp
Definition num_types.f90:8
integer, parameter, public rp
Global precision used in computations.
Definition num_types.f90:12
Operators.
Definition operators.f90:34
subroutine, public curl(w1, w2, w3, u1, u2, u3, work1, work2, coef, event)
Simulation components are objects that encapsulate functionality that can be fit to a particular comp...
subroutine compute_(this, t, tstep)
Dummy compute function.
Implements the vorticity_t type.
Definition vorticity.f90:36
subroutine vorticity_init_from_attributes(this)
Actual constructor.
subroutine vorticity_free(this)
Destructor.
subroutine vorticity_compute(this, t, tstep)
Compute the vorticity field.
subroutine vorticity_init_from_json(this, json, case)
Constructor from json.
Definition vorticity.f90:92
A simulation component that writes a 3d field to a file.
A simple output saving a list of fields to a .fld file.
Base abstract class for simulation components.
A simulation component that computes the vorticity field. Added to the field registry as omega_x,...
Definition vorticity.f90:53