-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathCRKSPHHydroBase.hh
225 lines (183 loc) · 8.55 KB
/
CRKSPHHydroBase.hh
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
//---------------------------------Spheral++----------------------------------//
// CRKSPHHydroBase -- The CRKSPH/ACRKSPH hydrodynamic package for Spheral++.
//
// Created by JMO, Mon Jul 19 21:52:29 PDT 2010
//----------------------------------------------------------------------------//
#ifndef __Spheral_CRKSPHHydroBase_hh__
#define __Spheral_CRKSPHHydroBase_hh__
#include "Physics/GenericHydro.hh"
#include "Geometry/CellFaceFlag.hh"
#include "RK/RKCorrectionParams.hh"
#include <string>
namespace Spheral {
template<typename Dimension> class State;
template<typename Dimension> class StateDerivatives;
template<typename Dimension> class ArtificialViscosity;
template<typename Dimension> class TableKernel;
template<typename Dimension> class DataBase;
template<typename Dimension, typename DataType> class Field;
template<typename Dimension, typename DataType> class FieldList;
class FileIO;
}
namespace Spheral {
template<typename Dimension>
class CRKSPHHydroBase: public GenericHydro<Dimension> {
public:
//--------------------------- Public Interface ---------------------------//
using Scalar = typename Dimension::Scalar;
using Vector = typename Dimension::Vector;
using Tensor = typename Dimension::Tensor;
using ThirdRankTensor = typename Dimension::ThirdRankTensor;
using FourthRankTensor = typename Dimension::FourthRankTensor;
using FifthRankTensor = typename Dimension::FifthRankTensor;
using SymTensor = typename Dimension::SymTensor;
using FacetedVolume = typename Dimension::FacetedVolume;
using ConstBoundaryIterator = typename Physics<Dimension>::ConstBoundaryIterator;
// Constructors.
CRKSPHHydroBase(DataBase<Dimension>& dataBase,
ArtificialViscosity<Dimension>& Q,
const RKOrder order,
const double filter,
const double cfl,
const bool useVelocityMagnitudeForDt,
const bool compatibleEnergyEvolution,
const bool evolveTotalEnergy,
const bool XSPH,
const MassDensityType densityUpdate,
const double epsTensile,
const double nTensile);
// No default constructor, copying, or assignment.
CRKSPHHydroBase() = delete;
CRKSPHHydroBase(const CRKSPHHydroBase&) = delete;
CRKSPHHydroBase& operator=(const CRKSPHHydroBase&) = delete;
// Destructor.
virtual ~CRKSPHHydroBase();
// Tasks we do once on problem startup.
virtual
void initializeProblemStartupDependencies(DataBase<Dimension>& dataBase,
State<Dimension>& state,
StateDerivatives<Dimension>& derivs) override;
// Register the state Hydro expects to use and evolve.
virtual
void registerState(DataBase<Dimension>& dataBase,
State<Dimension>& state) override;
// Register the derivatives/change fields for updating state.
virtual
void registerDerivatives(DataBase<Dimension>& dataBase,
StateDerivatives<Dimension>& derivs) override;
// This method is called once at the beginning of a timestep, after all state registration.
virtual void preStepInitialize(const DataBase<Dimension>& dataBase,
State<Dimension>& state,
StateDerivatives<Dimension>& derivs) override;
// Initialize the Hydro before we start a derivative evaluation.
virtual
void initialize(const Scalar time,
const Scalar dt,
const DataBase<Dimension>& dataBase,
State<Dimension>& state,
StateDerivatives<Dimension>& derivs) override;
// Evaluate the derivatives for the principle hydro variables:
// mass density, velocity, and specific thermal energy.
virtual
void evaluateDerivatives(const Scalar time,
const Scalar dt,
const DataBase<Dimension>& dataBase,
const State<Dimension>& state,
StateDerivatives<Dimension>& derivatives) const override;
// Finalize the derivatives.
virtual
void finalizeDerivatives(const Scalar time,
const Scalar dt,
const DataBase<Dimension>& dataBase,
const State<Dimension>& state,
StateDerivatives<Dimension>& derivs) const override;
// Apply boundary conditions to the physics specific fields.
virtual
void applyGhostBoundaries(State<Dimension>& state,
StateDerivatives<Dimension>& derivs) override;
// Enforce boundary conditions for the physics specific fields.
virtual
void enforceBoundaries(State<Dimension>& state,
StateDerivatives<Dimension>& derivs) override;
// We require RK corrections
virtual std::set<RKOrder> requireReproducingKernels() const override;
// The spatial order
RKOrder correctionOrder() const;
void correctionOrder(RKOrder val);
// Flag to choose whether we want to sum for density, or integrate
// the continuity equation.
MassDensityType densityUpdate() const;
void densityUpdate(MassDensityType type);
// Flag to determine if we're using the total energy conserving compatible energy
// evolution scheme.
bool compatibleEnergyEvolution() const;
void compatibleEnergyEvolution(bool val);
// Flag controlling if we evolve total or specific energy.
bool evolveTotalEnergy() const;
void evolveTotalEnergy(bool val);
// Flag to determine if we're using the XSPH algorithm.
bool XSPH() const;
void XSPH(bool val);
// Fraction of centroidal filtering to apply.
double filter() const;
void filter(double val);
// Parameters for the tensile correction force at small scales.
Scalar epsilonTensile() const;
void epsilonTensile(Scalar val);
Scalar nTensile() const;
void nTensile(Scalar val);
// The state field lists we're maintaining.
const FieldList<Dimension, int>& timeStepMask() const;
const FieldList<Dimension, Scalar>& pressure() const;
const FieldList<Dimension, Scalar>& soundSpeed() const;
const FieldList<Dimension, Scalar>& entropy() const;
const FieldList<Dimension, Scalar>& maxViscousPressure() const;
const FieldList<Dimension, Scalar>& effectiveViscousPressure() const;
const FieldList<Dimension, Scalar>& viscousWork() const;
const FieldList<Dimension, Vector>& XSPHDeltaV() const;
const FieldList<Dimension, Vector>& DxDt() const;
const FieldList<Dimension, Vector>& DvDt() const;
const FieldList<Dimension, Scalar>& DmassDensityDt() const;
const FieldList<Dimension, Scalar>& DspecificThermalEnergyDt() const;
const FieldList<Dimension, Tensor>& DvDx() const;
const FieldList<Dimension, Tensor>& internalDvDx() const;
const std::vector<Vector>& pairAccelerations() const;
//****************************************************************************
// Methods required for restarting.
virtual std::string label() const override { return "CRKSPHHydroBase"; }
virtual void dumpState(FileIO& file, const std::string& pathName) const;
virtual void restoreState(const FileIO& file, const std::string& pathName);
//****************************************************************************
protected:
//--------------------------- Protected Interface ---------------------------//
// A bunch of switches.
RKOrder mOrder;
MassDensityType mDensityUpdate;
bool mCompatibleEnergyEvolution, mEvolveTotalEnergy, mXSPH;
double mfilter;
Scalar mEpsTensile, mnTensile;
// Some internal scratch fields.
FieldList<Dimension, int> mTimeStepMask;
FieldList<Dimension, Scalar> mPressure;
FieldList<Dimension, Scalar> mSoundSpeed;
FieldList<Dimension, Scalar> mEntropy;
FieldList<Dimension, Scalar> mMaxViscousPressure;
FieldList<Dimension, Scalar> mEffViscousPressure;
FieldList<Dimension, Scalar> mViscousWork;
FieldList<Dimension, Vector> mXSPHDeltaV;
FieldList<Dimension, Vector> mDxDt;
FieldList<Dimension, Vector> mDvDt;
FieldList<Dimension, Scalar> mDmassDensityDt;
FieldList<Dimension, Scalar> mDspecificThermalEnergyDt;
FieldList<Dimension, SymTensor> mDHDt;
FieldList<Dimension, Tensor> mDvDx;
FieldList<Dimension, Tensor> mInternalDvDx;
std::vector<Vector> mPairAccelerations;
private:
//--------------------------- Private Interface ---------------------------//
// The restart registration.
RestartRegistrationType mRestart;
};
}
#include "CRKSPHHydroBaseInline.hh"
#endif