Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_HierarchicParallelism.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Panzer: A partial differential equation assembly
5// engine for strongly coupled complex multiphysics systems
6// Copyright (2011) Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact Roger P. Pawlowski (rppawlo@sandia.gov) and
39// Eric C. Cyr (eccyr@sandia.gov)
40// ***********************************************************************
41// @HEADER
42
43
44#ifndef PANZER_HIERARCHIC_PARALLELISM_HPP
45#define PANZER_HIERARCHIC_PARALLELISM_HPP
46
47#include "Phalanx_KokkosDeviceTypes.hpp"
48
49namespace panzer {
50
52 class HP {
59
60 HP();
61
62 public:
64 static HP& inst();
65
78 void overrideSizes(const int& team_size,
79 const int& vector_size,
80 const int& fad_vector_size,
81 const bool force_override_safety=false);
82
85
98 template<typename Scalar>
99 int vectorSize() const
100 {
101 return Sacado::IsADType<Scalar>::value ? fad_vector_size_ : vector_size_;
102 }
103
121 void setUseSharedMemory(const bool& use_shared_memory,
122 const bool& fad_use_shared_memory);
123
124 template<typename Scalar>
125 bool useSharedMemory() const
126 {
127 return Sacado::IsADType<Scalar>::value ? fad_use_shared_memory_ : use_shared_memory_;
128 }
129
131 template<typename ScalarT, typename ... TeamPolicyProperties>
132 Kokkos::TeamPolicy<TeamPolicyProperties...> teamPolicy(const int& league_size)
133 {
134 const int tmp_vector_size = this->template vectorSize<ScalarT>();
135
137 return Kokkos::TeamPolicy<TeamPolicyProperties...>(league_size,Kokkos::AUTO(),
138 tmp_vector_size);
139
140 return Kokkos::TeamPolicy<TeamPolicyProperties...>(league_size,team_size_,tmp_vector_size);
141 }
142
144 template<typename ScalarT, typename ... TeamPolicyProperties, typename ExecSpace>
145 Kokkos::TeamPolicy<ExecSpace, TeamPolicyProperties...> teamPolicy(ExecSpace exec_space, const int& league_size)
146 {
147 const int tmp_vector_size = this->template vectorSize<ScalarT>();
148
150 return Kokkos::TeamPolicy<TeamPolicyProperties...>(exec_space,league_size,Kokkos::AUTO(),
151 tmp_vector_size);
152
153 return Kokkos::TeamPolicy<TeamPolicyProperties...>(exec_space,league_size,team_size_,tmp_vector_size);
154 }
155 };
156
157}
158
159#endif
Singleton class for accessing kokkos hierarchical parallelism parameters.
int vectorSize() const
Returns the vector size. Specialized for AD scalar types.
int team_size_
If true, the team size is set with Kokkos::AUTO()
Kokkos::TeamPolicy< ExecSpace, TeamPolicyProperties... > teamPolicy(ExecSpace exec_space, const int &league_size)
Returns a TeamPolicy for hierarchic parallelism using an exec_space instance (for cuda streams).
static HP & inst()
Private ctor.
int vector_size_
User specified team size.
void setUseSharedMemory(const bool &use_shared_memory, const bool &fad_use_shared_memory)
Tell kokkos kernels if they should use shared memory. This is very problem dependent.
void resetSizes()
Reset the sizes to default.
Kokkos::TeamPolicy< TeamPolicyProperties... > teamPolicy(const int &league_size)
Returns a TeamPolicy for hierarchic parallelism.
bool fad_use_shared_memory_
Use shared memory kokkos kernels for non-fad types.
bool use_shared_memory_
FAD vector size.
HP()
Use shared memory kokkos kernels for fad types.
int fad_vector_size_
Default vector size for non-AD types.
void overrideSizes(const int &team_size, const int &vector_size, const int &fad_vector_size, const bool force_override_safety=false)