Homec4science
Diffusion SpecMiCP / ReactMiCP (reactmicp/unsaturated) Browse

specmicp/src/reactmicp/io/hdf5_unsaturated.hpp
fb013dc5d277reactmicp/unsaturated

Last Change
Raw File

hdf5_unsaturated.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_IO_REACTMICP_HDF5_UNSATURATED_HPP
#define SPECMICP_IO_REACTMICP_HDF5_UNSATURATED_HPP
//! \file reactmicp/io/hdf5_unsaturated.hpp
//! \brief HDF5 formatter for the unsaturated system
#include "../../types.hpp"
#include <memory>
namespace specmicp {
namespace reactmicp {
namespace systems {
namespace unsaturated {
class UnsaturatedVariables;
} //end namespace unsaturated
} //end namespace systems
} //end namespace reactmicp
namespace io {
class HDF5File;
//! \brief Save the unsaturated set of variables in HDF5 format
//!
class SPECMICP_DLL_PUBLIC UnsaturatedHDF5Saver
{
using UnsaturatedVariables = reactmicp::systems::unsaturated::UnsaturatedVariables;
public:
UnsaturatedHDF5Saver(std::shared_ptr<UnsaturatedVariables> vars);
~UnsaturatedHDF5Saver();
//! \brief Save the variables
//!
//! All the values will be saved in a new group 'section/name'
void save_timepoint(HDF5File& file,
const std::string& name,
const std::string& section
);
private:
struct SPECMICP_DLL_LOCAL UnsaturatedHDF5SaverImpl;
//! \brief implementation details
//! \internal
std::unique_ptr<UnsaturatedHDF5SaverImpl> m_impl;
// delete copy and assignement operator, no need for them
UnsaturatedHDF5Saver(const UnsaturatedHDF5Saver& other) = delete;
UnsaturatedHDF5Saver& operator= (const UnsaturatedHDF5Saver& other) = delete;
};
} //end namespace io
} //end namespace specmicp
#endif // SPECMICP_IO_REACTMICP_HDF5_UNSATURATED_HPP
c4science · Help