temporal_discretization.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2025 PRISMS Center at the University of Michigan
// SPDX-License-Identifier: GNU Lesser General Public Version 2.1
 
#pragma once
 
#include <prismspf/core/conditional_ostreams.h>
#include <prismspf/core/solve_group.h>
 
#include <prismspf/config.h>
 
PRISMS_PF_BEGIN_NAMESPACE
 
struct TemporalDiscretization
{
public:
  explicit TemporalDiscretization(double _dt = 1.0, unsigned int _num_increments = 1)
    : dt(_dt)
    , num_increments(_num_increments)
  {}
 
  TemporalDiscretization(double _dt, double final_time)
    : dt(_dt)
    , num_increments(uint((final_time + dt) / _dt))
  {}
 
  void
  validate()
  {}
 
  void
  print_parameter_summary() const;
 
  // Timestep
  double dt = 1.0;
 
  // Total number of increments
  unsigned int num_increments = 1;
};
 
inline void
TemporalDiscretization::print_parameter_summary() const
{
  ConditionalOStreams::pout_summary()
    << "================================================\n"
    << "  Temporal Discretization\n"
    << "================================================\n"
    << "Timestep: " << dt << "\n"
    << "Total increments: " << num_increments << "\n\n"
    << std::flush;
}
 
PRISMS_PF_END_NAMESPACE