Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F79253249
dumpable_iohelper.hh
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
Sun, Aug 25, 12:24
Size
8 KB
Mime Type
text/x-c++
Expires
Tue, Aug 27, 12:24 (1 d, 22 h)
Engine
blob
Format
Raw Data
Handle
20166508
Attached To
rAKA akantu
dumpable_iohelper.hh
View Options
/**
* @file dumpable_iohelper.hh
*
* @author Guillaume Anciaux <guillaume.anciaux@epfl.ch>
* @author David Simon Kammer <david.kammer@epfl.ch>
* @author Nicolas Richart <nicolas.richart@epfl.ch>
*
* @date creation: Tue Jan 06 2015
* @date last modification: Sun Dec 03 2017
*
* @brief Interface for object who wants to dump themselves
*
*
* Copyright (©) 2015-2018 EPFL (Ecole Polytechnique Fédérale de Lausanne)
* Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
*
* Akantu is free software: you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version.
*
* Akantu is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
* A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Akantu. If not, see <http://www.gnu.org/licenses/>.
*
*/
/* -------------------------------------------------------------------------- */
#include "dumper_iohelper.hh"
/* -------------------------------------------------------------------------- */
#include <set>
/* -------------------------------------------------------------------------- */
#ifndef AKANTU_DUMPABLE_IOHELPER_HH_
#define AKANTU_DUMPABLE_IOHELPER_HH_
/* -------------------------------------------------------------------------- */
namespace
akantu
{
class
Dumpable
{
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public
:
Dumpable
();
virtual
~
Dumpable
();
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
public
:
/// create a new dumper (of templated type T) and register it under
/// dumper_name. file_name is used for construction of T. is default states if
/// this dumper is the default dumper.
template
<
class
T
>
inline
void
registerDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
file_name
=
""
,
bool
is_default
=
false
);
/// register an externally created dumper
void
registerExternalDumper
(
std
::
shared_ptr
<
DumperIOHelper
>
dumper
,
const
std
::
string
&
dumper_name
,
bool
is_default
=
false
);
/// register a mesh to the default dumper
void
addDumpMesh
(
const
Mesh
&
mesh
,
UInt
spatial_dimension
=
_all_dimensions
,
GhostType
ghost_type
=
_not_ghost
,
ElementKind
element_kind
=
_ek_not_defined
);
/// register a mesh to the default identified by its name
void
addDumpMeshToDumper
(
const
std
::
string
&
dumper_name
,
const
Mesh
&
mesh
,
UInt
spatial_dimension
=
_all_dimensions
,
GhostType
ghost_type
=
_not_ghost
,
ElementKind
element_kind
=
_ek_not_defined
);
/// register a filtered mesh as the default dumper
void
addDumpFilteredMesh
(
const
Mesh
&
mesh
,
const
ElementTypeMapArray
<
UInt
>
&
elements_filter
,
const
Array
<
UInt
>
&
nodes_filter
,
UInt
spatial_dimension
=
_all_dimensions
,
GhostType
ghost_type
=
_not_ghost
,
ElementKind
element_kind
=
_ek_not_defined
);
/// register a filtered mesh and provides a name
void
addDumpFilteredMeshToDumper
(
const
std
::
string
&
dumper_name
,
const
Mesh
&
mesh
,
const
ElementTypeMapArray
<
UInt
>
&
elements_filter
,
const
Array
<
UInt
>
&
nodes_filter
,
UInt
spatial_dimension
=
_all_dimensions
,
GhostType
ghost_type
=
_not_ghost
,
ElementKind
element_kind
=
_ek_not_defined
);
/// to implement
virtual
void
addDumpField
(
const
std
::
string
&
field_id
);
/// to implement
virtual
void
addDumpFieldToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
);
/// add a field
virtual
void
addDumpFieldExternal
(
const
std
::
string
&
field_id
,
std
::
shared_ptr
<
dumpers
::
Field
>
field
);
virtual
void
addDumpFieldExternalToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
,
std
::
shared_ptr
<
dumpers
::
Field
>
field
);
template
<
typename
T
>
inline
void
addDumpFieldExternal
(
const
std
::
string
&
field_id
,
const
Array
<
T
>
&
field
);
template
<
typename
T
>
inline
void
addDumpFieldExternalToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
,
const
Array
<
T
>
&
field
);
template
<
typename
T
>
inline
void
addDumpFieldExternal
(
const
std
::
string
&
field_id
,
const
ElementTypeMapArray
<
T
>
&
field
,
UInt
spatial_dimension
=
_all_dimensions
,
GhostType
ghost_type
=
_not_ghost
,
ElementKind
element_kind
=
_ek_not_defined
);
template
<
typename
T
>
inline
void
addDumpFieldExternalToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
,
const
ElementTypeMapArray
<
T
>
&
field
,
UInt
spatial_dimension
=
_all_dimensions
,
GhostType
ghost_type
=
_not_ghost
,
ElementKind
element_kind
=
_ek_not_defined
);
void
removeDumpField
(
const
std
::
string
&
field_id
);
void
removeDumpFieldFromDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
);
virtual
void
addDumpFieldVector
(
const
std
::
string
&
field_id
);
virtual
void
addDumpFieldVectorToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
);
virtual
void
addDumpFieldTensor
(
const
std
::
string
&
field_id
);
virtual
void
addDumpFieldTensorToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
);
void
setDirectory
(
const
std
::
string
&
directory
);
void
setDirectoryToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
directory
);
void
setBaseName
(
const
std
::
string
&
basename
);
void
setBaseNameToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
basename
);
void
setTimeStepToDumper
(
Real
time_step
);
void
setTimeStepToDumper
(
const
std
::
string
&
dumper_name
,
Real
time_step
);
void
setTextModeToDumper
(
const
std
::
string
&
dumper_name
);
void
setTextModeToDumper
();
virtual
void
dump
();
virtual
void
dump
(
UInt
step
);
virtual
void
dump
(
Real
time
,
UInt
step
);
virtual
void
dump
(
const
std
::
string
&
dumper_name
);
virtual
void
dump
(
const
std
::
string
&
dumper_name
,
UInt
step
);
virtual
void
dump
(
const
std
::
string
&
dumper_name
,
Real
time
,
UInt
step
);
public
:
void
internalAddDumpFieldToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
,
std
::
shared_ptr
<
dumpers
::
Field
>
field
);
/* ------------------------------------------------------------------------ */
/* Accessors */
/* ------------------------------------------------------------------------ */
public
:
DumperIOHelper
&
getDumper
();
DumperIOHelper
&
getDumper
(
const
std
::
string
&
dumper_name
);
template
<
class
T
>
T
&
getDumper
(
const
std
::
string
&
dumper_name
);
std
::
string
getDefaultDumperName
()
const
;
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
private
:
using
DumperMap
=
std
::
map
<
std
::
string
,
std
::
shared_ptr
<
DumperIOHelper
>>
;
using
DumperSet
=
std
::
set
<
std
::
string
>
;
DumperMap
dumpers
;
std
::
string
default_dumper
;
};
}
// namespace akantu
#endif
/* AKANTU_DUMPABLE_IOHELPER_HH_ */
Event Timeline
Log In to Comment