VTK-m  2.0
ComputePotentialOnCandidates.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_on_candidates_h
52 #define vtkm_worklet_cosmotools_compute_potential_on_candidates_h
53 
55 
56 namespace vtkm
57 {
58 namespace worklet
59 {
60 namespace cosmotools
61 {
62 
63 // Worklet for computing the potential for a candidate particle
64 template <typename T>
66 {
67 public:
69 
70  using ControlSignature = void(FieldIn partId, // (input) particle is part of M
71  WholeArrayIn xLoc, // (input) x location in domain
72  WholeArrayIn yLoc, // (input) y location in domain
73  WholeArrayIn zLoc, // (input) z location in domain
74  FieldOut potential); // (output) bin ID
75  using ExecutionSignature = _5(_1, _2, _3, _4);
76  using InputDomain = _1;
77 
78  vtkm::Id nParticles; // Number of particles in halo
79  T mass; // Particle mass
80 
81  // Constructor
84  : nParticles(N)
85  , mass(Mass)
86  {
87  }
88 
89  template <typename InFieldPortalType>
91  const InFieldPortalType& xLoc,
92  const InFieldPortalType& yLoc,
93  const InFieldPortalType& zLoc) const
94  {
95  T potential = 0.0f;
96  for (vtkm::Id j = 0; j < nParticles; j++)
97  {
98  T xDist = xLoc.Get(i) - xLoc.Get(j);
99  T yDist = yLoc.Get(i) - yLoc.Get(j);
100  T zDist = zLoc.Get(i) - zLoc.Get(j);
101  T r = vtkm::Sqrt((xDist * xDist) + (yDist * yDist) + (zDist * zDist));
102  if ((i != j) && (fabs(r) > 0.00000000001f))
103  {
104  potential -= mass / r;
105  }
106  }
107  return potential;
108  }
109 }; // ComputePotentialOnCandidates
110 }
111 }
112 }
113 
114 #endif
vtkm::Sqrt
VTKM_EXEC_CONT vtkm::Float32 Sqrt(vtkm::Float32 x)
Compute the square root of x.
Definition: Math.h:958
vtkm::worklet::cosmotools::ComputePotentialOnCandidates::ComputePotentialOnCandidates
VTKM_EXEC_CONT ComputePotentialOnCandidates(vtkm::Id N, T Mass)
Definition: ComputePotentialOnCandidates.h:83
vtkm::worklet::cosmotools::ComputePotentialOnCandidates::mass
T mass
Definition: ComputePotentialOnCandidates.h:79
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::ComputePotentialOnCandidates::InputDomain
_1 InputDomain
Definition: ComputePotentialOnCandidates.h:76
vtkm::worklet::cosmotools::ComputePotentialOnCandidates::nParticles
vtkm::Id nParticles
Definition: ComputePotentialOnCandidates.h:78
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::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::worklet::cosmotools::ComputePotentialOnCandidates::operator()
VTKM_EXEC T operator()(const vtkm::Id &i, const InFieldPortalType &xLoc, const InFieldPortalType &yLoc, const InFieldPortalType &zLoc) const
Definition: ComputePotentialOnCandidates.h:90
vtkm::worklet::WorkletMapField::FieldIn
A control signature tag for input fields.
Definition: WorkletMapField.h:49
vtkm::worklet::cosmotools::ComputePotentialOnCandidates::ControlSignature
void(FieldIn partId, WholeArrayIn xLoc, WholeArrayIn yLoc, WholeArrayIn zLoc, FieldOut potential) ControlSignature
Definition: ComputePotentialOnCandidates.h:74
vtkm::worklet::cosmotools::ComputePotentialOnCandidates::ExecutionSignature
_5(_1, _2, _3, _4) ExecutionSignature
Definition: ComputePotentialOnCandidates.h:75
vtkm::List
Definition: List.h:34
vtkm::worklet::WorkletMapField
Base class for worklets that do a simple mapping of field arrays.
Definition: WorkletMapField.h:38
vtkm::worklet::cosmotools::ComputePotentialOnCandidates
Definition: ComputePotentialOnCandidates.h:65