Homec4science
Diffusion SpecMiCP / ReactMiCP (yaml/safe) Browse

specmicp/src/reactmicp/systems/saturated_react/diffusive_upscaling_stagger.hpp
4dbbf9cd6a19yaml/safe

Last Change
Raw File

diffusive_upscaling_stagger.hpp
View Options

/*-------------------------------------------------------------------------------
Copyright (c) 2015 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_SATDIFF_DIFFUSIVEUPSCALING_STAGGER
#define SPECMICP_REACTMICP_SATDIFF_DIFFUSIVEUPSCALING_STAGGER
//! \file diffusive_upscaling_stagger.hpp
//! \brief A diffusive upscaling stagger for the saturated system
#include "../../../database.hpp"
#include "../../solver/staggers_base/decl.inl"
#include "../../solver/staggers_base/variables_base.hpp"
#include "../../solver/staggers_base/upscaling_stagger_base.hpp"
#include "variablesfwd.hpp"
#include "../../../physics/units.hpp"
#include "../../../specmicp/adimensional/adimensional_system_solution_extractor.hpp"
#include <functional>
namespace specmicp {
namespace reactmicp {
namespace systems {
namespace satdiff {
using StaggerReturnCode = solver::StaggerReturnCode;
using VariablesBase = solver::VariablesBase;
//! \brief The type of a diffusion law
using diffusion_f = std::function<scalar_t (index_t, SaturatedVariables*)>;
//! \brief A function that return false if the computation must be stopped
using check_f = std::function<bool (SaturatedVariables*)>;
inline bool dummy_check(SaturatedVariables* _) {return true;}
//! \brief A upscaling stagger for a diffusive case
class SPECMICP_DLL_PUBLIC DiffusiveUpscalingStagger:
public solver::UpscalingStaggerBase
{
public:
// Initiation
// This is not call automatically so can be adjusted by the user
DiffusiveUpscalingStagger(
const diffusion_f& diffusion_law,
RawDatabasePtr& the_database,
units::UnitsSet the_units):
m_diffusion_law(diffusion_law),
m_data(the_database),
m_units_set(the_units),
m_dt(HUGE_VAL)
{
}
// Initialize the stagger at the beginning of the computation
// The porosity and transport properties should be initialized here
void initialize(VariablesBase* var) override;
// 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* var) override;
//! This is the main function called during a timestep
StaggerReturnCode restart_timestep(VariablesBase* var) override;
// Compute the upscaling for 'node'
void upscaling_one_node(index_t node, SaturatedVariables* true_var);
void set_checker(const check_f& checker) {m_checker = checker;}
private:
diffusion_f m_diffusion_law;
check_f m_checker {&dummy_check};
RawDatabasePtr m_data;
units::UnitsSet m_units_set;
scalar_t m_dt;
};
//! \brief The parameters for a power law
struct SPECMICP_DLL_PUBLIC PowerLawParameters
{
scalar_t exponent;
scalar_t d_eff_0;
scalar_t porosity_0;
scalar_t porosity_res;
};
//! \brief The power law
class PowerLaw
{
public:
PowerLaw(const PowerLawParameters& params):
m_param(params)
{}
scalar_t get_diffusion_coefficient(index_t node, SaturatedVariables* true_var);
diffusion_f get_law();
private:
PowerLawParameters m_param;
};
//! \brief The parameters for the capped power law
struct SPECMICP_DLL_PUBLIC CappedPowerLawParameters
{
scalar_t exponent;
scalar_t d_eff_0;
scalar_t porosity_0;
scalar_t porosity_res;
scalar_t cap;
};
//! \brief The capped power law
class SPECMICP_DLL_PUBLIC CappedPowerLaw
{
public:
CappedPowerLaw(const CappedPowerLawParameters& params):
m_param(params)
{}
scalar_t get_diffusion_coefficient(index_t node, SaturatedVariables* true_var);
diffusion_f get_law();
private:
CappedPowerLawParameters m_param;
};
} //end namespace satdiff
} //end namespace systems
} //end namespace reactmicp
} //end namespace specmicp
#endif // SPECMICP_REACTMICP_SATDIFF_DIFFUSIVEUPSCALING_STAGGER
c4science · Help