OutputDataSpecification.cpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#include "OutputDataSpecification.h"
 
#include "NumLib/TimeStepping/Time.h"
#include "NumLib/TimeStepping/TimeStep.h"
 
namespace ProcessLib
{
OutputDataSpecification::OutputDataSpecification(
    std::set<std::string>&& output_variables_,
    std::vector<double>&& fixed_output_times_,
    std::vector<PairRepeatEachSteps>&& repeats_each_steps_,
    bool const output_residuals_)
    : output_variables(std::move(output_variables_)),
      fixed_output_times(std::move(fixed_output_times_)),
      repeats_each_steps(std::move(repeats_each_steps_)),
      output_residuals(output_residuals_)
{
    if (!std::is_sorted(cbegin(fixed_output_times), cend(fixed_output_times)))
    {
        OGS_FATAL(
            "Vector of fixed output time steps passed to the "
            "OutputDataSpecification constructor must be sorted");
    }
    // check the repeats_each_steps pairs
    for (auto const& pair : repeats_each_steps)
    {
        if (pair.each_steps == 0)
        {
            OGS_FATAL(
                "Step in pair of <repeats><steps> is zero but has to be "
                "greater than zero.");
        }
    }
    if (repeats_each_steps.empty())
    {
        repeats_each_steps.emplace_back(1, std::numeric_limits<int>::max());
    }
}
 
bool OutputDataSpecification::isOutputStep(int timestep,
                                           NumLib::Time const& time) const
{
    auto isFixedOutputStep = [this](NumLib::Time const time) -> bool
    {
        return std::any_of(cbegin(fixed_output_times), cend(fixed_output_times),
                           [&](auto fixed_output_time)
                           { return NumLib::Time(fixed_output_time) == time; });
    };
 
    auto isPairRepeatsEachTimeStepOutput = [this](int timestep) -> bool
    {
        int each_steps = 1;
 
        for (auto const& pair : repeats_each_steps)
        {
            each_steps = pair.each_steps;
 
            if (timestep > pair.repeat * each_steps)
            {
                timestep -= pair.repeat * each_steps;
            }
            else
            {
                break;
            }
        }
 
        return timestep % each_steps == 0;
    };
 
    return isFixedOutputStep(time) || isPairRepeatsEachTimeStepOutput(timestep);
}
 
std::ostream& operator<<(std::ostream& os, PairRepeatEachSteps const& pair)
{
    os << "Output " << pair.repeat << " times every " << pair.each_steps
       << " timestep.\n";
    return os;
}
 
std::ostream& operator<<(std::ostream& os, OutputDataSpecification const& o)
{
    os << "OuputDataSpecification" << std::endl;
    os << "\toutput_variables: ";
    std::copy(o.output_variables.begin(), o.output_variables.end(),
              std::ostream_iterator<std::string>(os, " "));
    os << "\n";
    os << "\tfixed_output_times: ";
    std::copy(o.fixed_output_times.begin(), o.fixed_output_times.end(),
              std::ostream_iterator<double>(os, " "));
    os << "\n";
    os << "\trepeats_each_steps: ";
    std::copy(o.repeats_each_steps.begin(), o.repeats_each_steps.end(),
              std::ostream_iterator<PairRepeatEachSteps>(os, " "));
    os << "\n";
    os << "\toutput_residual: " << o.output_residuals << "\n";
    return os;
}
 
}  // namespace ProcessLib