PrecursorWriter.h

Go to the documentation of this file.

//=======================================================================================
// ____          ____    __    ______     __________   __      __       __        __
// \    \       |    |  |  |  |   _   \  |___    ___| |  |    |  |     /  \      |  |
//  \    \      |    |  |  |  |  |_)   |     |  |     |  |    |  |    /    \     |  |
//   \    \     |    |  |  |  |   _   /      |  |     |  |    |  |   /  /\  \    |  |
//    \    \    |    |  |  |  |  | \  \      |  |     |   \__/   |  /  ____  \   |  |____
//     \    \   |    |  |__|  |__|  \__\     |__|      \________/  /__/    \__\  |_______|
//      \    \  |    |   ________________________________________________________________
//       \    \ |    |  |  ______________________________________________________________|
//        \    \|    |  |  |         __          __     __     __     ______      _______
//         \         |  |  |_____   |  |        |  |   |  |   |  |   |   _  \    /  _____)
//          \        |  |   _____|  |  |        |  |   |  |   |  |   |  | \  \   \_______
//           \       |  |  |        |  |_____   |   \_/   |   |  |   |  |_/  /    _____  |
//            \ _____|  |__|        |________|   \_______/    |__|   |______/    (_______/
//
//  This file is part of VirtualFluids. VirtualFluids 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 3 of
//  the License, or (at your option) any later version.
//
//  VirtualFluids 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.
//
//  SPDX-License-Identifier: GPL-3.0-or-later
//  SPDX-FileCopyrightText: Copyright © VirtualFluids Project contributors, see AUTHORS.md in root folder
//
//=======================================================================================
 
#ifndef PRECURSORPROBE_H_
#define PRECURSORPROBE_H_
 
#include <future>
#include <stdexcept>
#include <string>
#include <vector>
 
#include <basics/DataTypes.h>
#include <basics/PointerDefinitions.h>
#include <basics/writer/WbWriterVtkXmlImageBinary.h>
 
#include <logger/Logger.h>
 
#include "Sampler.h"
 
namespace vf::gpu {
 
class Parameter;
class CudaMemoryManager;
 
class PrecursorWriter : public Sampler
{
public:
    enum class OutputVariable { Velocities, Distributions };
    enum class OutputVariableTemperature { Temperature, Distributions };
 
    PrecursorWriter(SPtr<Parameter> para, SPtr<CudaMemoryManager> cudaMemoryManager, const std::string& outputPath,
                    const std::string& probeName, real xPos, real yMin, real yMax, real zMin, real zMax,
                    uint tStartWritingOutput, uint tSave, OutputVariable outputVariable,
                    uint maxTimestepsPerFile = uint(1e4))
        : para(std::move(para)), cudaMemoryManager(std::move(cudaMemoryManager)), xPos(xPos), yMin(yMin), yMax(yMax),
          zMin(zMin), zMax(zMax), tStartWritingOutput(tStartWritingOutput), tSave(tSave), outputVariable(outputVariable),
          maxTimestepsPerFile(maxTimestepsPerFile), Sampler(outputPath, probeName)
    {
        nodeDataNames = determineNodeDataNames();
        writeFuture = std::async([]() {});
    };
 
    PrecursorWriter(SPtr<Parameter> para, SPtr<CudaMemoryManager> cudaMemoryManager, const std::string& outputPath,
                    const std::string& probeName, real xPos, real yMin, real yMax, real zMin, real zMax,
                    uint tStartWritingOutput, uint tSave, OutputVariable outputVariable,
                    OutputVariableTemperature tempOutputVariable, 
                    uint maxTimestepsPerFile = uint(1e4))
        : para(std::move(para)), cudaMemoryManager(std::move(cudaMemoryManager)), xPos(xPos), yMin(yMin), yMax(yMax),
        zMin(zMin), zMax(zMax), tStartWritingOutput(tStartWritingOutput), tSave(tSave), outputVariable(outputVariable),
        tempOutputVariable(tempOutputVariable), maxTimestepsPerFile(maxTimestepsPerFile), Sampler(outputPath, probeName)
    {
        nodeDataNames = determineNodeDataNames();
        writeFuture = std::async([]() {});
    };
 
    ~PrecursorWriter();
 
    void init() override;
    void sample(int level, uint t) override;
    void getTaggedFluidNodes(GridProvider* gridProvider) override;
 
    OutputVariable getOutputVariable()
    {
        return this->outputVariable;
    }
    OutputVariableTemperature getTempOutputVariable()
    {
        return this->tempOutputVariable;
    }
    struct PrecursorStruct
    {
        uint numberOfPointsInBC, numberOfPointsInData, numberOfTimeStepsPerFile, numberOfFilesWritten,
            numberOfTimeStepsBuffered;
        uint *indicesH, *indicesD;
        real *dataH, *dataD;
        real *bufferH, *bufferD;
        uint numberOfQuantities;
        UbTupleInt4 extent;
        UbTupleFloat2 origin;
        UbTupleFloat3 spacing;
        std::vector<int> indicesOnPlane;
        int streamIndex;
    };
 
    PrecursorStruct* getPrecursorStruct(int level)
    {
        return &precursorStructs[level];
    }
    std::string makeFileName(int level, uint numberOfFilesWritten);
 
    void setWritePrecision(uint writePrecision)
    {
        this->writePrecision = writePrecision;
    }
 
    static constexpr uint dP00 = 0;
    static constexpr uint dPP0 = 1;
    static constexpr uint dPM0 = 2;
    static constexpr uint dP0P = 3;
    static constexpr uint dP0M = 4;
    static constexpr uint dPPP = 5;
    static constexpr uint dPMP = 6;
    static constexpr uint dPPM = 7;
    static constexpr uint dPMM = 8;
 
private:
    WbWriterVtkXmlImageBinary* getWriter()
    {
        return WbWriterVtkXmlImageBinary::getInstance();
    };
    void write(int level, uint numberOfTimestepsBuffered);
 
    std::vector<std::string> determineNodeDataNames()
    {
        std::vector<std::string> res;
        
        switch (outputVariable) {
            case OutputVariable::Velocities:
                res = { "vx", "vy", "vz" };  
                break;
            case OutputVariable::Distributions:
                res = { "fP00", "fPP0", "fPM0", "fP0P", "fP0M", "fPPP", "fPMP", "fPPM", "fPMM" };
                break;
            default:
                throw std::runtime_error("Invalid OutputVariable for PrecursorWriter");
        }
 
        switch (tempOutputVariable) {
            case OutputVariableTemperature::Temperature:
                res.push_back("T");
                break;
            case OutputVariableTemperature::Distributions:
                res.insert(res.end(), {"gP00", "gPP0", "gPM0", "gP0P", "gP0M",
                                    "gPPP", "gPMP", "gPPM", "gPMM"});
                break;
            default:
                break;
        }
        return res;
    }
 
private:
    SPtr<Parameter> para;
    SPtr<CudaMemoryManager> cudaMemoryManager;
    std::vector<PrecursorStruct> precursorStructs;
    std::vector<std::string> nodeDataNames;
    std::vector<std::string> cellDataNames;
    uint tStartWritingOutput, tSave, maxTimestepsPerFile;
    real xPos, yMin, yMax, zMin, zMax;
    OutputVariable outputVariable;
    OutputVariableTemperature tempOutputVariable;
    std::future<void> writeFuture;
    uint writePrecision = 8;
};
 
}
 
#endif // PRECURSORPROBE_H_