aboutsummaryrefslogtreecommitdiff
path: root/Source/Diagnostics/ReducedDiags/ParticleEnergy.cpp
blob: b345e04bda64f93f9e12e8fca9224f6740e42588 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/* Copyright 2019-2021 Luca Fedeli, Yinjian Zhao
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */

#include "ParticleEnergy.H"

#include "Diagnostics/ReducedDiags/ReducedDiags.H"
#include "Particles/Algorithms/KineticEnergy.H"
#include "Particles/MultiParticleContainer.H"
#include "Particles/SpeciesPhysicalProperties.H"
#include "Particles/WarpXParticleContainer.H"
#include "WarpX.H"

#include <AMReX_GpuQualifiers.H>
#include <AMReX_PODVector.H>
#include <AMReX_ParallelDescriptor.H>
#include <AMReX_ParticleReduce.H>
#include <AMReX_Particles.H>
#include <AMReX_REAL.H>
#include <AMReX_Reduce.H>
#include <AMReX_Tuple.H>
#include <AMReX_Vector.H>

#include <algorithm>
#include <cmath>
#include <fstream>
#include <limits>
#include <map>
#include <vector>

using namespace amrex;

// constructor
ParticleEnergy::ParticleEnergy (std::string rd_name)
: ReducedDiags{rd_name}
{
    // get a reference to WarpX instance
    auto & warpx = WarpX::GetInstance();

    // get MultiParticleContainer class object
    const auto & mypc = warpx.GetPartContainer();

    // get number of species (int)
    const auto nSpecies = mypc.nSpecies();

    // resize data array
    m_data.resize(2*nSpecies+2, 0.0_rt);

    // get species names (std::vector<std::string>)
    const auto species_names = mypc.GetSpeciesNames();

    if (ParallelDescriptor::IOProcessor())
    {
        if ( m_IsNotRestart )
        {
            // open file
            std::ofstream ofs{m_path + m_rd_name + "." + m_extension, std::ofstream::out};
            // write header row
            int c = 0;
            ofs << "#";
            ofs << "[" << c++ << "]step()";
            ofs << m_sep;
            ofs << "[" << c++ << "]time(s)";
            ofs << m_sep;
            ofs << "[" << c++ << "]total(J)";
            for (int i = 0; i < nSpecies; ++i)
            {
                ofs << m_sep;
                ofs << "[" << c++ << "]" << species_names[i] + "(J)";
            }
            ofs << m_sep;
            ofs << "[" << c++ << "]total_mean(J)";
            for (int i = 0; i < nSpecies; ++i)
            {
                ofs << m_sep;
                ofs << "[" << c++ << "]" << species_names[i] + "_mean(J)";
            }
            ofs << std::endl;
            // close file
            ofs.close();
        }
    }
}

void ParticleEnergy::ComputeDiags (int step)
{
    // Check if the diags should be done
    if (m_intervals.contains(step+1) == false)
    {
        return;
    }

    // Get MultiParticleContainer class object
    const auto & mypc = WarpX::GetInstance().GetPartContainer();

    // Get number of species
    const int nSpecies = mypc.nSpecies();

    // Some useful offsets to fill m_data below
    int offset_total_species, offset_mean_species, offset_mean_all;

    amrex::Real Wtot = 0.0_rt;

    // Loop over species
    for (int i_s = 0; i_s < nSpecies; ++i_s)
    {
        // Get WarpXParticleContainer class object
        const auto & myspc = mypc.GetParticleContainer(i_s);

        // Get mass (used only for particles other than photons, see below)
        amrex::Real m = myspc.getMass();

        using PType = typename WarpXParticleContainer::SuperParticleType;

        amrex::Real Etot = 0.0_rt;
        amrex::Real Ws   = 0.0_rt;

        // Use amrex::ParticleReduce to compute the sum of energies and weights of all particles
        // held by the current MPI rank for this species (loop over all boxes held by this MPI rank):
        // the result r is the tuple (Etot, Ws)
        amrex::ReduceOps<ReduceOpSum, ReduceOpSum> reduce_ops;
        if(myspc.AmIA<PhysicalSpecies::photon>())
        {
            auto r = amrex::ParticleReduce<amrex::ReduceData<Real, Real>>(
                myspc,
                [=] AMREX_GPU_DEVICE(const PType& p) noexcept -> amrex::GpuTuple<Real, Real>
                {
                    const amrex::Real w  = p.rdata(PIdx::w);
                    const amrex::Real ux = p.rdata(PIdx::ux);
                    const amrex::Real uy = p.rdata(PIdx::uy);
                    const amrex::Real uz = p.rdata(PIdx::uz);
                    return {w*Algorithms::KineticEnergyPhotons(ux,uy,uz),w};
                },
                reduce_ops);

            Etot = amrex::get<0>(r);
            Ws   = amrex::get<1>(r);
        }
        else // particle other than photons
        {
            auto r = amrex::ParticleReduce<amrex::ReduceData<Real, Real>>(
                myspc,
                [=] AMREX_GPU_DEVICE(const PType& p) noexcept -> amrex::GpuTuple<Real, Real>
                {
                    const amrex::Real w  = p.rdata(PIdx::w);
                    const amrex::Real ux = p.rdata(PIdx::ux);
                    const amrex::Real uy = p.rdata(PIdx::uy);
                    const amrex::Real uz = p.rdata(PIdx::uz);

                    return {w*Algorithms::KineticEnergy(ux,uy,uz,m), w};
                },
                reduce_ops);

            Etot = amrex::get<0>(r);
            Ws   = amrex::get<1>(r);
        }

        // Reduced sum over MPI ranks
        ParallelDescriptor::ReduceRealSum(Etot, ParallelDescriptor::IOProcessorNumber());
        ParallelDescriptor::ReduceRealSum(Ws  , ParallelDescriptor::IOProcessorNumber());

        // Accumulate sum of weights over all species (must come after MPI reduction of Ws)
        Wtot += Ws;

        // Save results for this species i_s into m_data

        // Offset:
        // 1 value of total energy for all  species +
        // 1 value of total energy for each species
        offset_total_species = 1 + i_s;
        m_data[offset_total_species] = Etot;

        // Offset:
        // 1 value of total energy for all  species +
        // 1 value of total energy for each species +
        // 1 value of mean  energy for all  species +
        // 1 value of mean  energy for each species
        offset_mean_species = 1 + nSpecies + 1 + i_s;
        if (Ws > std::numeric_limits<Real>::min())
        {
            m_data[offset_mean_species] = Etot / Ws;
        }
        else
        {
            m_data[offset_mean_species] = 0.0_rt;
        }
    }

    // Total energy
    m_data[0] = 0.0_rt;

    // Loop over species
    for (int i_s = 0; i_s < nSpecies; ++i_s)
    {
        // Offset:
        // 1 value of total energy for all  species +
        // 1 value of total energy for each species
        offset_total_species = 1 + i_s;
        m_data[0] += m_data[offset_total_species];
    }

    // Total mean energy. Offset:
    // 1 value of total energy for all  species +
    // 1 value of total energy for each species
    offset_mean_all = 1 + nSpecies;
    if (Wtot > std::numeric_limits<Real>::min())
    {
        m_data[offset_mean_all] = m_data[0] / Wtot;
    }
    else
    {
        m_data[offset_mean_all] = 0.0_rt;
    }

    // m_data now contains up-to-date values for:
    // [total energy (all species)
    //  total energy (species 1)
    //  ...
    //  total energy (species n)
    //  mean  energy (all species)
    //  mean  energy (species 1)
    //  ...
    //  mean  energy (species n)]
}