summaryrefslogtreecommitdiff
path: root/src/core/powerLawUnitConverter.hh
blob: 309196a1a4c0ed90fae5d96e016a8c53325d079f (plain)
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
/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2017-2018 Max Gaedtke, Albert Mink, Davide Dapelo
 *  E-mail contact: info@openlb.net
 *  The most recent release of OpenLB can be downloaded at
 *  <http://www.openlb.net/>
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public
 *  License along with this program; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA  02110-1301, USA.
*/


#ifndef PL_UNITCONVERTER_HH
#define PL_UNITCONVERTER_HH

#include <fstream>
#include <iostream>
#include <unistd.h>
#include "core/singleton.h"
#include "io/fileName.h"

/// All OpenLB code is contained in this namespace.
namespace olb {

template <typename T, typename DESCRIPTOR>
void PowerLawUnitConverter<T, DESCRIPTOR>::print() const
{
  clout << "----------------- UnitConverter information ------------------" << std::endl;
  clout << "-- Parameters:" << std::endl;
  clout << "Resolution:                           N=              " << this->getResolution() << std::endl;
  clout << "DESCRIPTOR velocity:                     latticeU=       " << this->getCharLatticeVelocity() << std::endl;
  clout << "DESCRIPTOR relaxation frequency:         omega=          " << this->getLatticeRelaxationFrequency(  ) << std::endl;
  clout << "DESCRIPTOR relaxation time:              tau=            " << this->getLatticeRelaxationTime() << std::endl;
  clout << "Characteristical length(m):           charL=          " << this->getCharPhysLength() << std::endl;
  clout << "Characteristical speed(m/s):          charU=          " << this->getCharPhysVelocity() << std::endl;
  clout << "Phys. char kinematic visco(m^2/s):    charNu=         " << this->getPhysViscosity() << std::endl;
  clout << "Phys. consistency coeff(m^2 s^(n-2)): charM=          " << this->getPhysConsistencyCoeff() << std::endl;
  clout << "Power-law index:                      n=              " << this->getPowerLawIndex() << std::endl;
  clout << "Phys. density(kg/m^d):                charRho=        " << this->getPhysDensity() << std::endl;
  clout << "Characteristical pressure(N/m^2):     charPressure=   " << this->getCharPhysPressure() << std::endl;
  clout << "Reynolds number:                      reynoldsNumber= " << this->getReynoldsNumber() << std::endl;

  clout << std::endl;
  clout << "-- Conversion factors:" << std::endl;
  clout << "Voxel length(m):                      physDeltaX=     " << this->getConversionFactorLength() << std::endl;
  clout << "Time step(s):                         physDeltaT=     " << this->getConversionFactorTime() << std::endl;
  clout << "Velocity factor(m/s):                 physVelocity=   " << this->getConversionFactorVelocity() << std::endl;
  clout << "Density factor(kg/m^3):               physDensity=    " << this->getConversionFactorDensity() <<  std::endl;
  clout << "Mass factor(kg):                      physMass=       " << this->getConversionFactorMass() << std::endl;
  clout << "Viscosity factor(m^2/s):              physViscosity=  " << this->getConversionFactorViscosity() << std::endl;
  clout << "Force factor(N):                      physForce=      " << this->getConversionFactorForce() << std::endl;
  clout << "Pressure factor(N/m^2):               physPressure=   " << this->getConversionFactorPressure() << std::endl;

  clout << "--------------------------------------------------------------" << std::endl;

}

template <typename T, typename DESCRIPTOR>
void PowerLawUnitConverter<T, DESCRIPTOR>::write(std::string const& fileName) const
{
  std::string dataFile = singleton::directories().getLogOutDir() + fileName + ".dat";

  if (singleton::mpi().isMainProcessor())
  {
    std::ofstream fout;
    fout.open(dataFile.c_str(), std::ios::trunc);

    fout << "UnitConverter information\n\n";
    fout << "----------------- UnitConverter information ------------------\n";
    fout << "-- Parameters:" << std::endl;
    fout << "Resolution:                           N=              " << this->getResolution()                << "\n";
    fout << "DESCRIPTOR velocity:                     latticeU=       " << this->getCharLatticeVelocity()       << "\n";
    fout << "DESCRIPTOR relaxation frequency:         omega=          " << this->getLatticeRelaxationFrequency(  ) << std::endl;
    fout << "DESCRIPTOR relaxation time:              tau=            " << this->getLatticeRelaxationTime()     << "\n";
    fout << "Characteristical length(m):           charL=          " << this->getCharPhysLength()            << "\n";
    fout << "Characteristical speed(m/s):          charU=          " << this->getCharPhysVelocity()          << "\n";
    fout << "Phys. char kinematic visco(m^2/s):    charNu=         " << this->getPhysViscosity() << std::endl;
    fout << "Phys. consistency coeff(m^2 s^(n-2)): charM=          " << this->getPhysConsistencyCoeff() << std::endl;
    fout << "Power-law index:                      n=              " << this->getPowerLawIndex() << std::endl;
    fout << "Phys. density(kg/m^d):                charRho=        " << this->getPhysDensity()               << "\n";
    fout << "Characteristical pressure(N/m^2):     charPressure=   " << this->getCharPhysPressure()          << "\n";
    fout << "Reynolds number:                      reynoldsNumber= " << this->getReynoldsNumber() << std::endl;
    fout << "\n";
    fout << "-- Conversion factors:"                                                               << "\n";
    fout << "Voxel length(m):                      physDeltaX=     " << this->getConversionFactorLength() << std::endl;
    fout << "Time step(s):                         physDeltaT=     " << this->getConversionFactorTime()      << "\n";
    fout << "Velocity factor(m/s):                 physVelocity=   " << this->getConversionFactorVelocity()  << "\n";
    fout << "Density factor(kg/m^3):               physDensity=    " << this->getConversionFactorDensity()   << "\n";
    fout << "Mass factor(kg):                      physMass=       " << this->getConversionFactorMass()      << "\n";
    fout << "Viscosity factor(m^2/s):              physViscosity=  " << this->getConversionFactorViscosity() << "\n";
    fout << "Force factor(N):                      physForce=      " << this->getConversionFactorForce()     << "\n";
    fout << "Pressure factor(N/m^2):               physPressure=   " << this->getConversionFactorPressure()  << "\n";

    fout << "--------------------------------------------------------------" << "\n";

    fout.close();
  }
}

template<typename T, typename DESCRIPTOR>
PowerLawUnitConverter<T, DESCRIPTOR>* createPowerLawUnitConverter(XMLreader const& params)
{
  OstreamManager clout(std::cout,"createUnitConverter");
  params.setWarningsOn(false);

  T physDeltaX;
  T physDeltaT;

  T charPhysLength;
  T charPhysVelocity;
  T physViscosity;
  T physConsistencyCoeff;
  T powerLawIndex;
  T physDensity;
  T charPhysPressure = 0;

  int resolution;
  T latticeRelaxationTime;
  T charLatticeVelocity;

  // params[parameter].read(value) sets the value or returns false if the parameter can not be found
  params["Application"]["PhysParameters"]["CharPhysLength"].read(charPhysLength);
  params["Application"]["PhysParameters"]["CharPhysVelocity"].read(charPhysVelocity);
  params["Application"]["PhysParameters"]["PhysConsistencyCoeff"].read(physConsistencyCoeff);
  params["Application"]["PhysParameters"]["powerLawIndex"].read(powerLawIndex);
  params["Application"]["PhysParameters"]["PhysDensity"].read(physDensity);
  params["Application"]["PhysParameters"]["CharPhysPressure"].read(charPhysPressure);

  physViscosity = physConsistencyCoeff * pow(charPhysVelocity / (2*charPhysLength), powerLawIndex-1);

  if (!params["Application"]["Discretization"]["PhysDeltaX"].read(physDeltaX,false)) {
    if (!params["Application"]["Discretization"]["Resolution"].read<int>(resolution,false)) {
      if (!params["Application"]["Discretization"]["CharLatticeVelocity"].read(charLatticeVelocity,false)) {
        // NOT found physDeltaX, resolution or charLatticeVelocity
        clout << "Error: Have not found PhysDeltaX, Resolution or CharLatticeVelocity in XML file."
              << std::endl;
        exit (1);
      }
      else {
        // found charLatticeVelocity
        if (params["Application"]["Discretization"]["PhysDeltaT"].read(physDeltaT,false)) {
          physDeltaX = charPhysVelocity / charLatticeVelocity * physDeltaT;
        }
        else if (params["Application"]["Discretization"]["LatticeRelaxationTime"].read(latticeRelaxationTime,false)) {
          physDeltaX = physViscosity * charLatticeVelocity / charPhysVelocity * descriptors::invCs2<T,DESCRIPTOR>() / (latticeRelaxationTime - 0.5);
        }
      }
    }
    else {
      // found resolution
      physDeltaX = charPhysLength / resolution;
    }
  }
  // found physDeltaX
  if (!params["Application"]["Discretization"]["PhysDeltaT"].read(physDeltaT,false)) {
    if (!params["Application"]["Discretization"]["LatticeRelaxationTime"].read(latticeRelaxationTime,false)) {
      if (!params["Application"]["Discretization"]["CharLatticeVelocity"].read(charLatticeVelocity,false)) {
        // NOT found physDeltaT, latticeRelaxationTime and charLatticeVelocity
        clout << "Error: Have not found PhysDeltaT, LatticeRelaxationTime or CharLatticeVelocity in XML file."
              << std::endl;
        exit (1);
      }
      else