Homec4science
Diffusion akantu (features/friction_examples) Browse

rAKA/src/model/common/constitutive_laws/constitutive_law.hh
5f9734663cf3features/friction_examp…

Last Change
Raw File

constitutive_law.hh
View Options

/**
* @file constitutive_law.hh
*
* @author Daniel Pino Muñoz <daniel.pinomunoz@epfl.ch>
* @author Nicolas Richart <nicolas.richart@epfl.ch>
* @author Marco Vocialta <marco.vocialta@epfl.ch>
*
* @date creation: Fri Jun 18 2010
* @date last modification: Wed Feb 21 2018
*
* @brief Mother class for all constitutive laws
*
*
* Copyright (©) 2010-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 "data_accessor.hh"
#include "mesh_events.hh"
#include "parsable.hh"
#include "parser.hh"
/* -------------------------------------------------------------------------- */
#include "internal_field.hh"
#include "random_internal_field.hh"
/* -------------------------------------------------------------------------- */
namespace akantu {
class FEEngine;
}
#ifndef AKANTU_CONSTITUTIVE_LAW_HH_
#define AKANTU_CONSTITUTIVE_LAW_HH_
/* -------------------------------------------------------------------------- */
namespace akantu {
class ConstitutiveLawInternalHandler {
public:
ConstitutiveLawInternalHandler(const ID & id, Int dim,
const ID & fe_engine_id)
: id(id), spatial_dimension(dim), default_fe_engine_id(fe_engine_id) {
this->element_filter =
std::make_shared<ElementTypeMapArray<Idx>>("element_filter", id);
}
virtual ~ConstitutiveLawInternalHandler() = default;
ConstitutiveLawInternalHandler(ConstitutiveLawInternalHandler &&) noexcept =
delete;
ConstitutiveLawInternalHandler(const ConstitutiveLawInternalHandler &) =
delete;
ConstitutiveLawInternalHandler &
operator=(ConstitutiveLawInternalHandler &&) noexcept = delete;
ConstitutiveLawInternalHandler &
operator=(const ConstitutiveLawInternalHandler &) = delete;
template <typename T = Real,
template <typename Type> class InternalFieldType = InternalField>
inline InternalFieldType<T> & registerInternal(const ID & id,
Int nb_component);
template <typename T = Real,
template <typename Type> class InternalFieldType = InternalField>
inline InternalFieldType<T> &
registerInternal(const ID & id, Int nb_component, const ID & fe_engine_id);
template <typename T = Real,
template <typename Type> class InternalFieldType = InternalField>
inline InternalFieldType<T> &
registerInternal(const ID & id, Int nb_component, const ID & fe_engine_id,
const ElementTypeMapArray<Idx> & element_filter);
inline void unregisterInternal(const ID & id);
/// resize the internals arrrays
virtual void resizeInternals();
public:
/// save the internals in the previous_state if needed
virtual void savePreviousState();
/// restore the internals from previous_state if needed
virtual void restorePreviousState();
template <typename T = Real>
const InternalField<T> & getInternal(const ID & id) const;
template <typename T> InternalField<T> & getInternal(const ID & id);
template <typename T = Real,
template <typename Type> class InternalFieldType = InternalField>
std::shared_ptr<InternalFieldType<T>> getSharedPtrInternal(const ID & id);
template <typename T>
[[nodiscard]] inline bool isInternal(const ID & id,
const ElementKind & element_kind) const;
template <typename T>
const Array<T> & getArray(const ID & id, ElementType type,
GhostType ghost_type = _not_ghost) const;
template <typename T>
Array<T> & getArray(const ID & id, ElementType type,
GhostType ghost_type = _not_ghost);
inline void removeIntegrationPoints(ElementTypeMapArray<Idx> & new_numbering);
public:
[[nodiscard]] virtual const FEEngine &
getFEEngine(const ID & /*id*/ = "") const {
AKANTU_TO_IMPLEMENT();
}
[[nodiscard]] virtual FEEngine & getFEEngine(const ID & /*id*/ = "") {
AKANTU_TO_IMPLEMENT();
}
[[nodiscard]] Int getSpatialDimension() const { return spatial_dimension; }
[[nodiscard]] const ElementTypeMapArray<Idx> & getElementFilter() const {
return *element_filter;
}
[[nodiscard]] std::shared_ptr<const ElementTypeMapArray<Idx>>
getElementFilterSharedPtr() const {
return element_filter;
}
AKANTU_GET_MACRO_BY_ELEMENT_TYPE_CONST(ElementFilter, (*element_filter), Idx);
AKANTU_GET_MACRO(Name, name, const std::string &);
AKANTU_GET_MACRO(ID, id, const ID &);
protected:
[[nodiscard]] ElementTypeMapArray<Idx> & getElementFilter() {
return *element_filter;
}
AKANTU_GET_MACRO_BY_ELEMENT_TYPE(ElementFilter, (*element_filter), Idx);
private:
std::map<ID, std::shared_ptr<InternalFieldBase>> internal_vectors;
/// list of element handled by the constitutive law
std::shared_ptr<ElementTypeMapArray<Idx>> element_filter;
protected:
ID id;
// spatial dimension for constitutive law
Int spatial_dimension{0};
/// constitutive law name
std::string name;
/// ID of the FEEngine containing the interpolation points that are the
/// support of the internal fields
ID default_fe_engine_id;
};
/* -------------------------------------------------------------------------- */
/* -------------------------------------------------------------------------- */
template <class ConstitutiveLawsHandler_>
class ConstitutiveLaw : public ConstitutiveLawInternalHandler,
public DataAccessor<Element>,
public MeshEventHandler,
public Parsable {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
using ConstitutiveLawsHandler = ConstitutiveLawsHandler_;
/// Initialize constitutive law with defaults
ConstitutiveLaw(ConstitutiveLawsHandler & handler, const ID & id = "",
Int spatial_dimension = _all_dimensions,
ElementKind element_kind = _ek_regular,
const ID & fe_engine_id = "");
void printself(std::ostream & stream, int indent = 0) const override {
std::string space(indent, AKANTU_INDENT);
std::cout << "Constitutive Law [\n";
stream << space << " + id : " << id << "\n";
stream << space << " + name : " << name << "\n";
stream << space << " + spatial dimension : " << spatial_dimension << "\n";
stream << space << " + default FE Engine : " << default_fe_engine_id
<< "\n";
Parsable::printself(stream, indent + 1);
stream << space << "]\n";
}
protected:
void initialize();
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
public:
/// initialize the constitutive law computed parameter
virtual void initConstitutiveLaw();
/// add an element to the local mesh filter
inline Idx addElement(const Element & element);
/// add many elements at once
void addElements(const Array<Element> & elements_to_add);
/// remove many element at once
void removeElements(const Array<Element> & elements_to_remove);
[[nodiscard]] virtual Real getEnergy(const ID & /*energy_id*/) { return 0; }
[[nodiscard]] virtual Real getEnergy(const ID & /*energy_id*/,
const Element & /*element*/) {
return 0;
}
protected:
/// function called to update the internal parameters when the
/// modifiable parameters are modified
virtual void updateInternalParameters() {}
/// converts global element to local element
[[nodiscard]] inline Element
convertToLocalElement(const Element & global_element) const;
/// converts local element to global element
[[nodiscard]] inline Element
convertToGlobalElement(const Element & local_element) const;
/* ------------------------------------------------------------------------ */
/* DataAccessor inherited members */
/* ------------------------------------------------------------------------ */
public:
template <typename T>
inline void packInternalFieldHelper(const InternalField<T> & data_to_pack,
CommunicationBuffer & buffer,
const Array<Element> & elements) const;
template <typename T>
inline void unpackInternalFieldHelper(InternalField<T> & data_to_unpack,
CommunicationBuffer & buffer,
const Array<Element> & elements);
/* ------------------------------------------------------------------------ */
/* MeshEventHandler inherited members */
/* ------------------------------------------------------------------------ */
public:
/* ------------------------------------------------------------------------ */
void onNodesAdded(const Array<Idx> & /*unused*/,
const NewNodesEvent & /*unused*/) override{};
void onNodesRemoved(const Array<Idx> & /*unused*/,
const Array<Idx> & /*unused*/,
const RemovedNodesEvent & /*unused*/) override{};
void onElementsChanged(const Array<Element> & /*unused*/,
const Array<Element> & /*unused*/,
const ElementTypeMapArray<Idx> & /*unused*/,
const ChangedElementsEvent & /*unused*/) override{};
void onElementsAdded(const Array<Element> & /*unused*/,
const NewElementsEvent & /*unused*/) override;
void onElementsRemoved(const Array<Element> & element_list,
const ElementTypeMapArray<Idx> & new_numbering,
const RemovedElementsEvent & event) override;
public:
template <typename T> inline void setParam(const ID & param, T value);
[[nodiscard]] inline const Parameter & getParam(const ID & param) const;
template <typename T>
void flattenInternal(const std::string & field_id,
ElementTypeMapArray<T> & internal_flat,
GhostType ghost_type = _not_ghost,
ElementKind element_kind = _ek_not_defined) const;
template <typename T>
void inflateInternal(const std::string & field_id,
const ElementTypeMapArray<T> & field,
GhostType ghost_type, ElementKind element_kind);
/* ------------------------------------------------------------------------ */
/* Accessors */
/* ------------------------------------------------------------------------ */
public:
[[nodiscard]] const FEEngine &
getFEEngine(const ID & id = "") const override {
return handler.getFEEngine(id.empty() ? default_fe_engine_id : id);
}
[[nodiscard]] FEEngine & getFEEngine(const ID & id = "") override {
return handler.getFEEngine(id.empty() ? default_fe_engine_id : id);
}
template <typename T>
[[nodiscard]] ElementTypeMap<Int>
getInternalDataPerElem(const ID & id, ElementKind element_kind) const;
AKANTU_GET_MACRO_AUTO(Handler, handler);
AKANTU_GET_MACRO_AUTO_NOT_CONST(Handler, handler);
template <typename... pack>
decltype(auto) elementTypes(pack &&... _pack) const {
return this->getElementFilter().elementTypes(std::forward<pack>(_pack)...);
}
protected:
[[nodiscard]] bool isInit() const { return is_init; }
/* ------------------------------------------------------------------------ */
/* Class Members */
/* ------------------------------------------------------------------------ */
private:
/// boolean to know if the constitutive law has been initialized
bool is_init{false};
protected:
// Constitutive law handler for which this is a constitutive law
ConstitutiveLawsHandler & handler;
};
template <class ConstitutiveLawsHandler_>
inline std::ostream &
operator<<(std::ostream & stream,
const ConstitutiveLaw<ConstitutiveLawsHandler_> & _this) {
_this.printself(stream);
return stream;
}
} // namespace akantu
#include "constitutive_law_tmpl.hh"
#include "internal_field_tmpl.hh"
#include "random_internal_field_tmpl.hh"
#endif
c4science · Help