Homec4science
Diffusion SpecMiCP / ReactMiCP (dev) Browse

specmicp/src/reactmicp/systems/chloride/upscaling_stagger_factory.hpp
20ed7ad3d222dev

Last Change
Raw File

upscaling_stagger_factory.hpp
View Options

/* =============================================================================
Copyright (c) 2014-2017 F. Georget <fabieng@princeton.edu> Princeton University
Copyright (c) 2017-2018 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_CHLORIDE_UPSCALINGSTAGGERFACTORY_HPP
#define SPECMICP_REACTMICP_CHLORIDE_UPSCALINGSTAGGERFACTORY_HPP
//! \file chloride/upscaling_stagger_factory.hpp
//! \brief Factory class for an UpscalingStagger
#include <memory>
namespace specmicp {
namespace io {
class YAMLConfigHandle;
} //end namespace io
namespace reactmicp {
namespace solver {
class UpscalingStaggerBase;
} //end namespace solver
namespace systems {
namespace chloride {
struct SimulationData;
//! \brief Factory class to be use as a plugin base class
class UpscalingStaggerFactory
{
public:
UpscalingStaggerFactory() = default;
virtual ~UpscalingStaggerFactory() = default;
//! \brief Return an Upscaling stagger
virtual std::shared_ptr<solver::UpscalingStaggerBase> get_upscaling_stagger(
SimulationData& data,
io::YAMLConfigHandle&& configuration
) = 0;
};
} //end namespace chloride
} //end namespace systems
} //end namespace reactmicp
} //end namespace specmicp
#endif // SPECMICP_REACTMICP_CHLORIDE_UPSCALINGSTAGGERFACTORY_HPP
c4science · Help