Page MenuHomec4science

saturation_equation.hpp
No OneTemporary

File Metadata

Created
Thu, Jun 27, 21:32

saturation_equation.hpp

/*------------------------------------------------------------------------------
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_UNSATURATED_SATURATIONEQUATION_HPP
#define SPECMICP_REACTMICP_UNSATURATED_SATURATIONEQUATION_HPP
//! \file unsaturated/saturation_equation.hpp
//! \brief The saturation equation for the unsaturated system
#include "../../../types.hpp"
#include "fv_1dof_equation.hpp"
#include "../../../dfpm/meshes/mesh1dfwd.hpp"
#include "variables.hpp"
namespace specmicp {
namespace reactmicp {
namespace systems {
namespace unsaturated {
class TransportConstraints;
//! \brief The saturation equation
//!
//! Solve the transport of liquid water
class SPECMICP_DLL_LOCAL SaturationEquation:
public FV1DOFEquation<SaturationEquation>
{
using base = FV1DOFEquation<SaturationEquation>;
using base::get_scaling;
using base::register_number_equations;
public:
SaturationEquation(
mesh::Mesh1DPtr the_mesh,
SaturationVariableBox& variables,
const TransportConstraints& constraints);
~SaturationEquation();
//! \brief Return the id of equation dof
index_t id_equation_impl(index_t id_dof);
mesh::Mesh1D* get_mesh_impl();
void pre_nodal_residual_hook_impl(index_t node, const Vector& displacement);
void pre_residual_hook_impl(const Vector& displacement);
void post_residual_hook_impl(const Vector& displacement);
//! \brief Compute the residuals inside 'element' for 'component'
void residuals_element_impl(
index_t element,
const Vector& displacement,
const Vector& velocity,
Eigen::Vector2d& element_residual,
bool use_chemistry_rate
);
//! \brief Set the relative variables
void set_relative_variables(const Vector& displacement);
void compute_transport_rate(scalar_t dt, const Vector& displacement);
private:
void number_equations(const TransportConstraints& constraints);
struct SaturationEquationImpl;
std::unique_ptr<SaturationEquationImpl> m_impl;
};
} //end namespace unsaturated
} //end namespace systems
} //end namespace reactmicp
} //end namespace specmicp
#endif // SPECMICP_REACTMICP_UNSATURATED_SATURATIONEQUATION_HPP

Event Timeline