Homec4science
Diffusion SpecMiCP / ReactMiCP (yaml/safe) Browse

specmicp/src/reactmicp/systems/unsaturated/transport_stagger.hpp
d20480d9c835yaml/safe

Last Change
Raw File

transport_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_UNSATURATED_TRANSPORTSTAGGER_HPP
#define SPECMICP_REACTMICP_UNSATURATED_TRANSPORTSTAGGER_HPP
//! \file unsaturated/transport_stagger.hpp
//! \brief The unsaturated transport stagger
#include "../../solver/staggers_base/transport_stagger_base.hpp"
#include "../../../utils/pimpl_ptr.hpp"
namespace specmicp {
namespace dfpmsolver {
struct ParabolicDriverOptions;
} //end namespace dfpmsolver
namespace reactmicp {
namespace systems {
namespace unsaturated {
class UnsaturatedVariables;
class TransportConstraints;
class SPECMICP_DLL_PUBLIC UnsaturatedTransportStagger:
public solver::TransportStaggerBase
{
using VariablesBase = solver::VariablesBase;
using StaggerReturnCode = solver::StaggerReturnCode;
public:
UnsaturatedTransportStagger(
std::shared_ptr<UnsaturatedVariables> variables,
const TransportConstraints& constraints,
bool merge_saturation_pressure=false,
bool merge_aqueous_pressure=false
);
~UnsaturatedTransportStagger();
//! \brief Initialize the stagger at the beginning of an iteration
//!
//! This is where the first residual may be computed, the predictor saved, ...
//! \param dt the duration of the timestep
//! \param var shared_ptr to the variables
void initialize_timestep(scalar_t dt, VariablesBase * const var) override;
//! \brief Solve the equation for the timetep
//!
//! \param var shared_ptr to the variables
StaggerReturnCode restart_timestep(VariablesBase * const var) override;
//! \brief Compute the residuals norm
//!
//! \param var shared_ptr to the variables
scalar_t get_residual(VariablesBase * const var) override;
//! \brief Compute the residuals norm
//!
//! \param var shared_ptr to the variables
scalar_t get_residual_0(VariablesBase * const var) override;
//! \brief Obtain the norm of the step size
//!
//! This is used to check if the algorithm has reach a stationary points.
//! It should look like : return main_variables.norm()
//!
//! \param var shared_ptr to the variables
scalar_t get_update(VariablesBase * const var) override;
//! Return options of saturation equation
//!
//! \return the options or nullptr if the equation does not exist
dfpmsolver::ParabolicDriverOptions* get_saturation_options();
//! return options of aqueous transport equation
//!
//! \return the options or nullptr if the equation does not exist
dfpmsolver::ParabolicDriverOptions* get_aqueous_options(index_t component);
//! return options of gas transport equation
//!
//! \return the options or nullptr if the equation does not exist
dfpmsolver::ParabolicDriverOptions* get_gas_options(index_t component);
private:
// The implementation details
class UnsaturatedTransportStaggerImpl;
utils::pimpl_ptr<UnsaturatedTransportStaggerImpl> m_impl;
};
//! \brief Return a shared pointer to the transport stagger
//!
//! \param variables shared_pointer to the unsaturated variables
//! \param constraints The transport constraints
//! \param merge_saturation_pressure true if the saturation
//! and water vapor pressure equations must be merged
inline std::shared_ptr<UnsaturatedTransportStagger>
unsaturated_transport_stagger(
std::shared_ptr<UnsaturatedVariables> variables,
const TransportConstraints& constraints,
bool merge_saturation_pressure = false,
bool merge_aqueous_pressure = false
)
{
return std::make_shared<UnsaturatedTransportStagger>(
variables, constraints,
merge_saturation_pressure, merge_aqueous_pressure
);
}
} //end namespace unsaturated
} //end namespace systems
} //end namespace reactmicp
} //end namespace specmicp
#endif // SPECMICP_REACTMICP_UNSATURATED_TRANSPORTSTAGGER_HPP
c4science · Help