Homec4science
Diffusion SpecMiCP / ReactMiCP (chloride) Browse

specmicp/src/reactmicp/solver/timestepper.hpp
b7feed8c4364chloride

Last Change
Raw File

timestepper.hpp
View Options

/* =============================================================================
Copyright (c) 2014 - 2016
F. Georget <fabieng@princeton.edu> Princeton University
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
============================================================================= */
#ifndef SPECMICP_REACTMICP_SOLVER_TIMESTEPPER_HPP
#define SPECMICP_REACTMICP_SOLVER_TIMESTEPPER_HPP
#include "specmicp_common/moving_average.hpp"
#include "specmicp_common/options_handler.hpp"
namespace specmicp {
namespace reactmicp {
namespace solver {
// forward declaration
enum class ReactiveTransportReturnCode;
//! \brief Options for the timestepper
struct SPECMICP_DLL_PUBLIC TimestepperOptions
{
scalar_t lower_bound; //!< Lower bound for the timestep
scalar_t upper_bound; //!< Upper bound for the timestep
scalar_t restart_timestep; //!< Value used when restarting the problem
scalar_t iteration_lower_target{1.01}; //!< Lower target for the number of iterations
scalar_t iteration_upper_target{15.0}; //!< Upper target for the number of iterations
scalar_t alpha_average{0.5}; //!< Parameter for the exponential moving average
scalar_t decrease_failure{0.5}; //!< Reduction factor in case of failure
scalar_t increase_error_minimization{1.3}; //!< Increase factor in case of error minimization
scalar_t decrease_factor{0.75}; //!< Reduction factor to get the number of iterations inside the target
scalar_t increase_factor{1.25}; //!< Increase factor to get the number of iterations inside the target
TimestepperOptions(scalar_t dt_lower_bound, scalar_t dt_upper_bound):
lower_bound(dt_lower_bound),
upper_bound(dt_upper_bound),
restart_timestep(dt_lower_bound)
{}
};
//! \brief Adaptative timestepper for the reactive transport solver
class SPECMICP_DLL_PUBLIC Timestepper: public OptionsHandler<TimestepperOptions>
{
public:
//! \brief Constructor
//!
//! \param dt_lower_bound lower_bound for the timestep
//! \param dt_upper_bound upper_bound for the timestep
//! \param total_target total target time
//! \param init_iterations initial iterations
Timestepper(scalar_t dt_lower_bound,
scalar_t dt_upper_bound,
scalar_t total_target,
scalar_t init_iterations
):
OptionsHandler(dt_lower_bound, dt_upper_bound),
m_total(0),
m_total_target(total_target),
m_average(0.5, init_iterations)
{
m_average.set_alpha(get_options().alpha_average);
}
//! \brief Return the total time
scalar_t get_total() const {return m_total;}
//! \brief Return the total target time
scalar_t get_total_target() const {return m_total_target;}
//! \brief Set the total target time
void set_total_target(scalar_t total_target) {m_total_target = total_target;}
void set_average_parameter(scalar_t alpha) {
get_options().alpha_average = alpha;
m_average.set_alpha(alpha);
}
//! obtain the next timestep
scalar_t next_timestep(scalar_t dt_done, ReactiveTransportReturnCode return_code, index_t nb_iterations);
private:
scalar_t m_total;
scalar_t m_total_target;
utils::ExponentialMovingAverage m_average;
};
} // end namespace solver
} // end namespace reactmicp
} // end namespace specmicp
#endif // SPECMICP_REACTMICP_SOLVER_TIMESTEPPER_HPP
c4science · Help