Homec4science
Diffusion SpecMiCP / ReactMiCP (master) Browse

specmicp/src/reactmicp/systems/single/default_upscaling_stagger.hpp
b2c071e32a99master

Last Change
Raw File

default_upscaling_stagger.hpp
View Options

/* =============================================================================
Copyright (c)
2014-2017 F. Georget <fabieng@princeton.edu> Princeton University
2017-2021 F. Georget <fabien.georget@epfl.ch> EPFL
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_SYSTEMS_SINGLE_DEFAULTUPSCALINGPROGRAM_HPP
#define SPECMICP_REACTMICP_SYSTEMS_SINGLE_DEFAULTUPSCALINGPROGRAM_HPP
#include "reactmicp/solver/staggers_base/variables_base.hpp"
#include "reactmicp/solver/staggers_base/upscaling_stagger_base.hpp"
#include "variablesfwd.hpp"
#include "reactmicp/solver/staggers_base/stagger_structs.hpp"
namespace specmicp {
namespace reactmicp {
#ifndef SPC_DOXYGEN_SHOULD_SKIP_THIS
using StaggerReturnCode = solver::StaggerReturnCode;
using VariablesBase = solver::VariablesBase;
#endif // SPC_DOXYGEN_SHOULD_SKIP_THIS
namespace systems {
namespace single {
class SPECMICP_DLL_PUBLIC SingleUpscalingStagger:
public solver::UpscalingStaggerBase
{
public:
//! \brief Constructor
//!
//! By defautl does nothing
SingleUpscalingStagger():
m_dt(HUGE_VAL)
{}
//! \brief Initialize the stagger at the beginning of the computation
//!
//! The porosity and transport properties should be initialized here
void initialize(VariablesBase * const var) override {}
//! \brief Initialize the stagger at the beginning of a timestep
//!
//! Typically do nothing but erase the "dot" variable (velocity such as the vel_porosity)
void initialize_timestep(scalar_t dt, VariablesBase * const var) override {
m_dt = dt;
}
//! \brief This is the main function called during a timestep
StaggerReturnCode restart_timestep(VariablesBase * const var) override {
return StaggerReturnCode::ResidualMinimized;
}
private:
scalar_t m_dt; //!< The current timestep
};
} // end namespace single
} // end namespace systems
} // end namespace reactmicp
} // end namespace specmicp
#endif // SPECMICP_REACTMICP_SYSTEMS_SINGLE_DEFAULTUPSCALINGPROGRAM_HPP
c4science · Help