Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F78723977
model.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
Thu, Aug 22, 15:09
Size
11 KB
Mime Type
text/x-c++
Expires
Sat, Aug 24, 15:09 (1 d, 23 h)
Engine
blob
Format
Raw Data
Handle
20015727
Attached To
rAKA akantu
model.hh
View Options
/**
* @file model.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 Jul 27 2010
* @date last modification: Fri Sep 05 2014
*
* @brief Interface of a model
*
* @section LICENSE
*
* Copyright (©) 2010-2012, 2014 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/>.
*
*/
/* -------------------------------------------------------------------------- */
#ifndef __AKANTU_MODEL_HH__
#define __AKANTU_MODEL_HH__
/* -------------------------------------------------------------------------- */
#include "aka_common.hh"
#include "aka_memory.hh"
#include "mesh.hh"
#include "fe_engine.hh"
#include "mesh_utils.hh"
#include "synchronizer_registry.hh"
#include "distributed_synchronizer.hh"
#include "static_communicator.hh"
#include "mesh_partition.hh"
#include "dof_synchronizer.hh"
#include "pbc_synchronizer.hh"
#include "parser.hh"
/* -------------------------------------------------------------------------- */
__BEGIN_AKANTU__
struct
ModelOptions
{
virtual
~
ModelOptions
()
{}
};
class
DumperIOHelper
;
class
Model
:
public
Memory
{
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public
:
typedef
Mesh
mesh_type
;
Model
(
Mesh
&
mesh
,
UInt
spatial_dimension
=
_all_dimensions
,
const
ID
&
id
=
"model"
,
const
MemoryID
&
memory_id
=
0
);
virtual
~
Model
();
typedef
std
::
map
<
std
::
string
,
FEEngine
*>
FEEngineMap
;
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
public
:
virtual
void
initFull
(
const
ModelOptions
&
options
);
virtual
void
initModel
()
=
0
;
/// create the synchronizer registry object
void
createSynchronizerRegistry
(
DataAccessor
*
data_accessor
);
/// create a parallel synchronizer and distribute the mesh
DistributedSynchronizer
&
createParallelSynch
(
MeshPartition
*
partition
,
DataAccessor
*
data_accessor
);
/// change local equation number so that PBC is assembled properly
void
changeLocalEquationNumberForPBC
(
std
::
map
<
UInt
,
UInt
>
&
pbc_pair
,
UInt
dimension
);
/// function to print the containt of the class
virtual
void
printself
(
std
::
ostream
&
stream
,
int
indent
=
0
)
const
=
0
;
/// initialize the model for PBC
void
setPBC
(
UInt
x
,
UInt
y
,
UInt
z
);
void
setPBC
(
SurfacePairList
&
surface_pairs
);
virtual
void
initPBC
();
/// set the parser to use
void
setParser
(
Parser
&
parser
);
/* ------------------------------------------------------------------------ */
/* Access to the dumpable interface of the boundaries */
/* ------------------------------------------------------------------------ */
/// Dump the data for a given group
void
dumpGroup
(
const
std
::
string
&
group_name
);
void
dumpGroup
(
const
std
::
string
&
group_name
,
const
std
::
string
&
dumper_name
);
/// Dump the data for all boundaries
void
dumpGroup
();
/// Set the directory for a given group
void
setGroupDirectory
(
const
std
::
string
&
directory
,
const
std
::
string
&
group_name
);
/// Set the directory for all boundaries
void
setGroupDirectory
(
const
std
::
string
&
directory
);
/// Set the base name for a given group
void
setGroupBaseName
(
const
std
::
string
&
basename
,
const
std
::
string
&
group_name
);
/// Get the internal dumper of a given group
DumperIOHelper
&
getGroupDumper
(
const
std
::
string
&
group_name
);
/* ------------------------------------------------------------------------ */
/* Accessors */
/* ------------------------------------------------------------------------ */
public
:
/// get id of model
AKANTU_GET_MACRO
(
ID
,
id
,
const
ID
)
/// get the number of surfaces
AKANTU_GET_MACRO
(
Mesh
,
mesh
,
Mesh
&
);
/// return the object handling equation numbers
AKANTU_GET_MACRO
(
DOFSynchronizer
,
*
dof_synchronizer
,
const
DOFSynchronizer
&
)
/// return the object handling synchronizers
AKANTU_GET_MACRO
(
SynchronizerRegistry
,
*
synch_registry
,
SynchronizerRegistry
&
)
/// synchronize the boundary in case of parallel run
virtual
void
synchronizeBoundaries
()
{};
/// return the fem object associated with a provided name
inline
FEEngine
&
getFEEngine
(
const
ID
&
name
=
""
)
const
;
/// return the fem boundary object associated with a provided name
virtual
FEEngine
&
getFEEngineBoundary
(
const
ID
&
name
=
""
);
/// register a fem object associated with name
template
<
typename
FEEngineClass
>
inline
void
registerFEEngineObject
(
const
std
::
string
&
name
,
Mesh
&
mesh
,
UInt
spatial_dimension
);
/// unregister a fem object associated with name
inline
void
unRegisterFEEngineObject
(
const
std
::
string
&
name
);
/// return the synchronizer registry
SynchronizerRegistry
&
getSynchronizerRegistry
();
/// return the fem object associated with a provided name
template
<
typename
FEEngineClass
>
inline
FEEngineClass
&
getFEEngineClass
(
std
::
string
name
=
""
)
const
;
/// return the fem boundary object associated with a provided name
template
<
typename
FEEngineClass
>
inline
FEEngineClass
&
getFEEngineClassBoundary
(
std
::
string
name
=
""
);
/// get the pbc pairs
std
::
map
<
UInt
,
UInt
>
&
getPBCPairs
(){
return
pbc_pair
;};
/// returns if node is slave in pbc
inline
bool
isPBCSlaveNode
(
const
UInt
node
)
const
;
/// returns the array of pbc slave nodes (boolean information)
AKANTU_GET_MACRO
(
IsPBCSlaveNode
,
is_pbc_slave_node
,
const
Array
<
bool
>
&
)
/* ------------------------------------------------------------------------ */
/* Pack and unpack helper functions */
/* ------------------------------------------------------------------------ */
public
:
inline
UInt
getNbIntegrationPoints
(
const
Array
<
Element
>
&
elements
,
const
ID
&
fem_id
=
ID
())
const
;
/* ------------------------------------------------------------------------ */
/* Dumpable interface (kept for convenience) and dumper relative functions */
/* ------------------------------------------------------------------------ */
void
setTextModeToDumper
();
virtual
void
addDumpGroupFieldToDumper
(
const
std
::
string
&
field_id
,
dumper
::
Field
*
field
,
DumperIOHelper
&
dumper
);
virtual
void
addDumpField
(
const
std
::
string
&
field_id
);
virtual
void
addDumpFieldVector
(
const
std
::
string
&
field_id
);
virtual
void
addDumpFieldToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
);
virtual
void
addDumpFieldVectorToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
);
virtual
void
addDumpFieldTensorToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
);
virtual
void
addDumpFieldTensor
(
const
std
::
string
&
field_id
);
virtual
void
setBaseName
(
const
std
::
string
&
basename
);
virtual
void
setBaseNameToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
basename
);
virtual
void
addDumpGroupField
(
const
std
::
string
&
field_id
,
const
std
::
string
&
group_name
);
virtual
void
addDumpGroupFieldToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
,
const
std
::
string
&
group_name
,
const
ElementKind
&
element_kind
,
bool
padding_flag
);
virtual
void
addDumpGroupFieldToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
,
const
std
::
string
&
group_name
,
UInt
spatial_dimension
,
const
ElementKind
&
element_kind
,
bool
padding_flag
);
virtual
void
removeDumpGroupField
(
const
std
::
string
&
field_id
,
const
std
::
string
&
group_name
);
virtual
void
removeDumpGroupFieldFromDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
,
const
std
::
string
&
group_name
);
virtual
void
addDumpGroupFieldVector
(
const
std
::
string
&
field_id
,
const
std
::
string
&
group_name
);
virtual
void
addDumpGroupFieldVectorToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
field_id
,
const
std
::
string
&
group_name
);
virtual
dumper
::
Field
*
createNodalFieldReal
(
const
std
::
string
&
field_name
,
const
std
::
string
&
group_name
,
bool
padding_flag
){
return
NULL
;}
virtual
dumper
::
Field
*
createNodalFieldUInt
(
const
std
::
string
&
field_name
,
const
std
::
string
&
group_name
,
bool
padding_flag
){
return
NULL
;}
virtual
dumper
::
Field
*
createNodalFieldBool
(
const
std
::
string
&
field_name
,
const
std
::
string
&
group_name
,
bool
padding_flag
){
return
NULL
;}
virtual
dumper
::
Field
*
createElementalField
(
const
std
::
string
&
field_name
,
const
std
::
string
&
group_name
,
bool
padding_flag
,
const
UInt
&
spatial_dimension
,
const
ElementKind
&
kind
){
return
NULL
;}
void
setDirectory
(
const
std
::
string
&
directory
);
void
setDirectoryToDumper
(
const
std
::
string
&
dumper_name
,
const
std
::
string
&
directory
);
virtual
void
dump
();
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
protected
:
/// Mesh
Mesh
&
mesh
;
/// Spatial dimension of the problem
UInt
spatial_dimension
;
/// the main fem object present in all models
FEEngineMap
fems
;
/// the fem object present in all models for boundaries
FEEngineMap
fems_boundary
;
/// default fem object
std
::
string
default_fem
;
/// synchronizer registry
SynchronizerRegistry
*
synch_registry
;
/// handle the equation number things
DOFSynchronizer
*
dof_synchronizer
;
/// pbc pairs
std
::
map
<
UInt
,
UInt
>
pbc_pair
;
/// flag per node to know is pbc slave
Array
<
bool
>
is_pbc_slave_node
;
/// parser to the pointer to use
Parser
*
parser
;
};
/* -------------------------------------------------------------------------- */
/* inline functions */
/* -------------------------------------------------------------------------- */
#if defined (AKANTU_INCLUDE_INLINE_IMPL)
# include "model_inline_impl.cc"
#endif
/// standard output stream operator
inline
std
::
ostream
&
operator
<<
(
std
::
ostream
&
stream
,
const
Model
&
_this
)
{
_this
.
printself
(
stream
);
return
stream
;
}
__END_AKANTU__
#endif
/* __AKANTU_MODEL_HH__ */
Event Timeline
Log In to Comment