Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F97142212
hdf5_timesteps.hpp
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Thu, Jan 2, 21:32
Size
5 KB
Mime Type
text/x-c++
Expires
Sat, Jan 4, 21:32 (1 d, 23 h)
Engine
blob
Format
Raw Data
Handle
23336820
Attached To
rSPECMICP SpecMiCP / ReactMiCP
hdf5_timesteps.hpp
View Options
/* =============================================================================
Copyright (c) 2014 - 2016
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_UTILS_IO_HDF5TIMESTEPS_HPP
#define SPECMICP_UTILS_IO_HDF5TIMESTEPS_HPP
//! \file utils/io/hdf5_timesteps.hpp
//! \brief Class to contain the list of timesteps in a HDF5 file
#include "../../macros.hpp"
#include "H5public.h"
// herr_t
#include "H5Ipublic.h"
// hid_t
#include <string>
#include <vector>
#include <algorithm>
namespace
specmicp
{
namespace
io
{
class
HDF5File
;
/*!
\brief Contain the list of timesteps in a HDF5 file
Call HDF5Timesteps::initialize to initialize the container with the timesteps
*/
class
SPECMICP_DLL_PUBLIC
HDF5Timesteps
{
public
:
//! Type of the timestep as numbers
using
ScalarT
=
double
;
//! Type of the timestep as strings
using
StrT
=
std
::
string
;
//! Type of the pair <timestep-number,timestep-string>
using
ValT
=
std
::
pair
<
ScalarT
,
StrT
>
;
//! Type of the iterator over the vector
using
iterator
=
std
::
vector
<
ValT
>::
iterator
;
//! Type of the const iterator over the container
using
const_iterator
=
std
::
vector
<
ValT
>::
const_iterator
;
//! \brief Default constructor
//!
//! When using tihs constructor, the user must call 'initialize' to
//! initialize the timestep vector
//!
//! \sa initialize
HDF5Timesteps
()
{}
//! \brief Overloaded constructor, initialize the timestep vector
HDF5Timesteps
(
HDF5File
&
the_file
)
{
initialize
(
the_file
);
}
//! \brief Initialize the timesteps
void
initialize
(
HDF5File
&
the_file
);
void
initialize
(
HDF5File
&
the_file
,
const
std
::
string
&
section
);
//! \brief Return the timestep-number from the timestep-string
ScalarT
get_number
(
const
StrT
&
str
)
{
return
string_to_number
(
str
);
}
//! \brief Return the timestep-string from the timestep-number
const
std
::
string
&
get_string
(
const
ScalarT
&
value
);
//! \brief Return a const iterator to the beginning
const_iterator
begin
()
{
return
m_values
.
cbegin
();}
const_iterator
cbegin
()
{
return
m_values
.
cbegin
();}
//! \brief Return a const iterator to the end
const_iterator
end
()
{
return
m_values
.
cend
();}
const_iterator
cend
()
{
return
m_values
.
cend
();}
//! \brief Return the number of timesteps
std
::
size_t
size
()
{
return
m_values
.
size
();}
private
:
//! \brief Transform a string to a number
static
ScalarT
string_to_number
(
const
StrT
&
str
)
{
return
std
::
stod
(
str
);
}
static
ScalarT
string_to_number
(
const
char
*
str
)
{
return
string_to_number
(
std
::
string
(
str
));
}
//! \brief Find the lower_bound of value using a binary search
iterator
lower_bound
(
const
ScalarT
&
value
);
//! \brief Sort the vector
void
sort
();
//! \brief Add a value
void
push_back
(
const
StrT
&
value
)
{
m_values
.
emplace_back
(
string_to_number
(
value
),
value
);
}
//! \brief Add a value
void
push_back
(
const
ScalarT
&
number
,
const
StrT
&
str
)
{
m_values
.
emplace_back
(
number
,
str
);
}
//! \brief Compare two timesteps
static
bool
compare_keys
(
const
ValT
&
a
,
const
ValT
&
b
)
{
return
(
a
.
first
<
b
.
first
);
}
//! \brief Add a value if this is a timestep
//!
//! This is the function call by H5GIterate
static
herr_t
add_element_if_timestep
(
hid_t
_
,
const
char
*
name
,
void
*
void_this
);
//! \brief Allocate memory in advance
void
reserve
(
std
::
size_t
size_to_reserve
)
{
m_values
.
reserve
(
size_to_reserve
);
}
std
::
vector
<
ValT
>
m_values
;
//! \brief Contains the values
};
}
//end namespace io
}
//end namespace specmicp
#endif
// SPECMICP_UTILS_IO_HDF5TIMESTEPS_HPP
Event Timeline
Log In to Comment