VTK-m  2.0
ComputePotential.h
Go to the documentation of this file.
1 //============================================================================
2 // Copyright (c) Kitware, Inc.
3 // All rights reserved.
4 // See LICENSE.txt for details.
5 //
6 // This software is distributed WITHOUT ANY WARRANTY; without even
7 // the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
8 // PURPOSE. See the above copyright notice for more information.
9 //============================================================================
10 // Copyright (c) 2016, Los Alamos National Security, LLC
11 // All rights reserved.
12 //
13 // Copyright 2016. Los Alamos National Security, LLC.
14 // This software was produced under U.S. Government contract DE-AC52-06NA25396
15 // for Los Alamos National Laboratory (LANL), which is operated by
16 // Los Alamos National Security, LLC for the U.S. Department of Energy.
17 // The U.S. Government has rights to use, reproduce, and distribute this
18 // software. NEITHER THE GOVERNMENT NOR LOS ALAMOS NATIONAL SECURITY, LLC
19 // MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY FOR THE
20 // USE OF THIS SOFTWARE. If software is modified to produce derivative works,
21 // such modified software should be clearly marked, so as not to confuse it
22 // with the version available from LANL.
23 //
24 // Additionally, redistribution and use in source and binary forms, with or
25 // without modification, are permitted provided that the following conditions
26 // are met:
27 //
28 // 1. Redistributions of source code must retain the above copyright notice,
29 // this list of conditions and the following disclaimer.
30 // 2. Redistributions in binary form must reproduce the above copyright notice,
31 // this list of conditions and the following disclaimer in the documentation
32 // and/or other materials provided with the distribution.
33 // 3. Neither the name of Los Alamos National Security, LLC, Los Alamos
34 // National Laboratory, LANL, the U.S. Government, nor the names of its
35 // contributors may be used to endorse or promote products derived from
36 // this software without specific prior written permission.
37 //
38 // THIS SOFTWARE IS PROVIDED BY LOS ALAMOS NATIONAL SECURITY, LLC AND
39 // CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
40 // BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
41 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL LOS ALAMOS
42 // NATIONAL SECURITY, LLC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
43 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
44 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
45 // USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
46 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
47 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
48 // THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
49 //============================================================================
50 
51 #ifndef vtkm_worklet_cosmotools_compute_potential_h
52 #define vtkm_worklet_cosmotools_compute_potential_h
53 
55 
56 namespace vtkm
57 {
58 namespace worklet
59 {
60 namespace cosmotools
61 {
62 
63 // Worklet for computing the potential for a particle
64 template <typename T>
66 {
67 public:
69 
70  using ControlSignature = void(FieldIn index, // (input) particle Id
71  WholeArrayIn partId, // (input) first particle in halo
72  WholeArrayIn xLoc, // (input) x location in domain
73  WholeArrayIn yLoc, // (input) y location in domain
74  WholeArrayIn zLoc, // (input) z location in domain
75  WholeArrayIn firstParticleId, // (input) first particle in halo
76  WholeArrayIn lastParticleId, // (input) last particle in halo
77  FieldOut potential); // (output) bin ID
78  using ExecutionSignature = _8(_1, _2, _3, _4, _5, _6, _7);
79  using InputDomain = _1;
80 
81  T mass;
82 
83  // Constructor
86  : mass(Mass)
87  {
88  }
89 
90  template <typename InFieldPortalType, typename InIdPortalType, typename PermutePortalType>
92  const InIdPortalType& partId,
93  const InFieldPortalType& xLoc,
94  const InFieldPortalType& yLoc,
95  const InFieldPortalType& zLoc,
96  const InIdPortalType& firstParticleId,
97  const PermutePortalType& lastParticleId) const
98  {
99  // Worklet index is into array of particle ids sorted by bin
100  // Current particle and other particles retrieved from partId array
101  vtkm::Id iId = partId.Get(i);
102  T potential = 0.0f;
103 
104  // first and last particle are arranged by sorted bin id so they match index and not the partId
105  for (vtkm::Id j = firstParticleId.Get(i); j <= lastParticleId.Get(i); j++)
106  {
107  vtkm::Id jId = partId.Get(j);
108  T xDist = xLoc.Get(iId) - xLoc.Get(jId);
109  T yDist = yLoc.Get(iId) - yLoc.Get(jId);
110  T zDist = zLoc.Get(iId) - zLoc.Get(jId);
111  T r = vtkm::Sqrt((xDist * xDist) + (yDist * yDist) + (zDist * zDist));
112  if ((i != j) && (fabs(r) > 0.00000000001f))
113  potential -= mass / r;
114  }
115  return potential;
116  }
117 }; // ComputePotential
118 }
119 }
120 }
121 
122 #endif
vtkm::worklet::cosmotools::ComputePotential::mass
T mass
Definition: ComputePotential.h:81
vtkm::Sqrt
VTKM_EXEC_CONT vtkm::Float32 Sqrt(vtkm::Float32 x)
Compute the square root of x.
Definition: Math.h:958
VTKM_EXEC
#define VTKM_EXEC
Definition: ExportMacros.h:51
vtkm
Groups connected points that have the same field value.
Definition: Atomic.h:19
vtkm::worklet::cosmotools::ComputePotential::InputDomain
_1 InputDomain
Definition: ComputePotential.h:79
vtkm::worklet::cosmotools::ComputePotential::ComputePotential
VTKM_EXEC_CONT ComputePotential(T Mass)
Definition: ComputePotential.h:85
WorkletMapField.h
VTKM_EXEC_CONT
#define VTKM_EXEC_CONT
Definition: ExportMacros.h:52
vtkm::worklet::WorkletMapField::FieldOut
A control signature tag for output fields.
Definition: WorkletMapField.h:60
vtkm::worklet::cosmotools::ComputePotential::ControlSignature
void(FieldIn index, WholeArrayIn partId, WholeArrayIn xLoc, WholeArrayIn yLoc, WholeArrayIn zLoc, WholeArrayIn firstParticleId, WholeArrayIn lastParticleId, FieldOut potential) ControlSignature
Definition: ComputePotential.h:77
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::cosmotools::ComputePotential::operator()
VTKM_EXEC T operator()(const vtkm::Id &i, const InIdPortalType &partId, const InFieldPortalType &xLoc, const InFieldPortalType &yLoc, const InFieldPortalType &zLoc, const InIdPortalType &firstParticleId, const PermutePortalType &lastParticleId) const
Definition: ComputePotential.h:91
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
vtkm::List
Definition: List.h:34
vtkm::worklet::cosmotools::ComputePotential::ExecutionSignature
_8(_1, _2, _3, _4, _5, _6, _7) ExecutionSignature
Definition: ComputePotential.h:78
vtkm::worklet::cosmotools::ComputePotential
Definition: ComputePotential.h:65
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38