Neko  0.9.0
A portable framework for high-order spectral element flow simulations
ax_helm_fctry.f90
Go to the documentation of this file.
1 ! Copyright (c) 2021-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 !
33 submodule(ax_product) ax_helm_fctry
37  use ax_helm_xsmm, only : ax_helm_xsmm_t
38  use ax_helm_sx, only : ax_helm_sx_t
39  use ax_helm, only : ax_helm_t
40  use ax_helm_cpu, only : ax_helm_cpu_t
43  use utils, only : neko_error
44  implicit none
45 
46 contains
47 
53  module subroutine ax_helm_factory(object, full_formulation)
54  class(ax_t), allocatable, intent(inout) :: object
55  logical, intent(in) :: full_formulation
56 
57  if (allocated(object)) then
58  deallocate(object)
59  end if
60 
61  if (full_formulation) then
62  if (neko_bcknd_sx .eq. 1 .or. neko_bcknd_xsmm .eq. 1) then
63  call neko_error("Full stress formulation is only available &
64  &on the CPU and device")
65  else if (neko_bcknd_device .eq. 1) then
66  allocate(ax_helm_full_device_t::object)
67  else
68  allocate(ax_helm_full_cpu_t::object)
69  end if
70  else
71  if (neko_bcknd_sx .eq. 1) then
72  allocate(ax_helm_sx_t::object)
73  else if (neko_bcknd_xsmm .eq. 1) then
74  allocate(ax_helm_xsmm_t::object)
75  else if (neko_bcknd_device .eq. 1) then
76  allocate(ax_helm_device_t::object)
77  else
78  allocate(ax_helm_cpu_t::object)
79  end if
80  end if
81 
82  end subroutine ax_helm_factory
83 
84 
85 end submodule ax_helm_fctry
Defines a Matrix-vector product.
Definition: ax.f90:34
Build configurations.
Definition: neko_config.f90:34
integer, parameter neko_bcknd_sx
Definition: neko_config.f90:39
integer, parameter neko_bcknd_device
Definition: neko_config.f90:44
integer, parameter neko_bcknd_xsmm
Definition: neko_config.f90:40
Utilities.
Definition: utils.f90:35
Matrix-vector product for a Helmholtz problem.
Definition: ax_helm.f90:44
CPU matrix-vector product for a Helmholtz problem.
Definition: ax_helm_cpu.f90:44
CPU matrix-vector product for a Helmholtz problem with full stress tensor.