Detailed Description

Holds information about which variables to write to output files.

Definition at line 38 of file OutputDataSpecification.h.

#include <OutputDataSpecification.h>

Public Member Functions
	OutputDataSpecification (std::set< std::string > &&output_variables_, std::vector< double > &&fixed_output_times_, std::vector< PairRepeatEachSteps > &&repeats_each_steps_, bool const output_residuals_)

bool	isOutputStep (int timestep, NumLib::Time const &time) const

Public Attributes
std::set< std::string >	output_variables
	All variables that shall be output.

std::vector< double >	fixed_output_times
	Given times that steps have to reach.

std::vector< PairRepeatEachSteps >	repeats_each_steps
	Describes after which timesteps to write output.

bool	output_residuals
	Tells if also to output extrapolation residuals.

Constructor & Destructor Documentation

◆ OutputDataSpecification()

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_ )

Definition at line 18 of file OutputDataSpecification.cpp.

    : 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());
    }
}

References fixed_output_times, OGS_FATAL, and repeats_each_steps.

Member Function Documentation

◆ isOutputStep()

bool ProcessLib::OutputDataSpecification::isOutputStep	(	int	timestep,
		NumLib::Time const &	time ) const

Determines if there should be output at the given timestep or time.

Definition at line 50 of file OutputDataSpecification.cpp.

{
    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);
}