/usr/include/palabos/basicDynamics/thermalDynamics.h is in libplb-dev 1.5~r1+repack1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* This file is part of the Palabos library.
*
* Copyright (C) 2011-2015 FlowKit Sarl
* Route d'Oron 2
* 1010 Lausanne, Switzerland
* E-mail contact: contact@flowkit.com
*
* The most recent release of Palabos can be downloaded at
* <http://www.palabos.org/>
*
* The library Palabos is free software: you can redistribute it and/or
* modify it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* The library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** \file
* A collection of dynamics classes (e.g. BGK) with which a Cell object
* can be instantiated -- header file.
*/
#ifndef THERMAL_DYNAMICS_H
#define THERMAL_DYNAMICS_H
#include "core/globalDefs.h"
#include "core/dynamics.h"
namespace plb {
/// Common base iso-thermal (or athermal) bulk dynamics
template<typename T, template<typename U> class Descriptor>
class ThermalBulkDynamics : public BasicBulkDynamics<T,Descriptor> {
public:
ThermalBulkDynamics(T omega_);
/* *************** Collision, Equilibrium, and Non-equilibrium ******* */
/// Re-compute particle populations from the leading moments
virtual void regularize(Cell<T,Descriptor>& cell, T rhoBar, Array<T,Descriptor<T>::d> const& j,
T jSqr, Array<T,SymmetricTensor<T,Descriptor>::n> const& PiNeq, T thetaBar=T() ) const;
/* *************** Computation of macroscopic variables ************** */
/// Compute the temperature in lattice units
virtual T computeTemperature(Cell<T,Descriptor> const& cell) const;
/// Compute the "off-equilibrium part of Pi"
virtual void computePiNeq (
Cell<T,Descriptor> const& cell, Array<T,SymmetricTensor<T,Descriptor>::n>& PiNeq ) const;
/// Compute the deviatoric stress tensor
virtual void computeShearStress (
Cell<T,Descriptor> const& cell, Array<T,SymmetricTensor<T,Descriptor>::n>& stress ) const;
/// Compute the heat flux in lattice units
virtual void computeHeatFlux( Cell<T,Descriptor> const& cell,
Array<T,Descriptor<T>::d>& q ) const;
/* *************** Switch between population and moment representation ****** */
/// Number of variables required to decompose a population representation into moments.
/** In the present implementation, the decomposition is carried out up to order-1 in the
* Chapman-Enskog expansion. Example: Take the D2Q9 lattice. A decomposition means:
* - At order 0: Decompose into rho, u, and fNeq (1+2+9=12 variables)
* - At order 1: Decompose into rho, u, and PiNeq (1+2+3=6 variables)
* - At higher order: Decompose according to order 1.
*/
virtual plint numDecomposedVariables(plint order) const;
/// Decompose from population representation into moment representation.
/** \sa numDecomposedVariables()
*/
virtual void decompose(Cell<T,Descriptor> const& cell, std::vector<T>& rawData, plint order) const;
/// Recompose from moment representation to population representation.
/** \sa numDecomposedVariables()
* This process is also known as "regularization step", and this function is therefore
* equivalent to regularize(), although one or the other function may be more useful
* in a specific context, due to the form of the parameters.
*/
virtual void recompose(Cell<T,Descriptor>& cell, std::vector<T> const& rawData, plint order) const;
/// Change the space and time scales of the variables in moment representation.
/** \sa numDecomposedVariables()
* \param xDxInv Inverse of the factor by which space scale is multiplied.
* \param xDt Factor by which time scale is multiplied.
*/
virtual void rescale(std::vector<T>& rawData, T xDxInv, T xDt, plint order) const;
/* *************** Additional moments, intended for internal use ***** */
/// Returns 0, as a default value for isothermal flow.
virtual T computeEbar(Cell<T,Descriptor> const& cell) const;
private:
virtual void decomposeOrder0(Cell<T,Descriptor> const& cell, std::vector<T>& rawData) const;
virtual void decomposeOrder1(Cell<T,Descriptor> const& cell, std::vector<T>& rawData) const;
virtual void recomposeOrder0(Cell<T,Descriptor>& cell, std::vector<T> const& rawData) const;
virtual void recomposeOrder1(Cell<T,Descriptor>& cell, std::vector<T> const& rawData) const;
virtual void rescaleOrder0(std::vector<T>& rawData, T xDxInv, T xDt) const;
virtual void rescaleOrder1(std::vector<T>& rawData, T xDxInv, T xDt) const;
};
/// Implementation of O(Ma^2) BGK dynamics
template<typename T, template<typename U> class Descriptor>
class ThermalBGKdynamics : public ThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
ThermalBGKdynamics(T omega_);
/// Clone the object on its dynamic type.
virtual ThermalBGKdynamics<T,Descriptor>* clone() const;
/// Return a unique ID for this class.
virtual int getId() const;
/* *************** Collision and Equilibrium ************************* */
/// Implementation of the collision step
virtual void collide(Cell<T,Descriptor>& cell,
BlockStatistics& statistics_);
/// Compute equilibrium distribution function
virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
T jSqr, T thetaBar=T()) const;
private:
static int id;
};
}
#endif
|