Homec4science
Diffusion akantu (features/ci_code_quality) Browse

rAKA/src/model/dof_manager.hh
4eda3f0153cdfeatures/ci_code_quality

Last Change
Raw File

dof_manager.hh
View Options

/**
* @file dof_manager.hh
*
* @author Nicolas Richart <nicolas.richart@epfl.ch>
*
* @date Wed Jul 22 11:43:43 2015
*
* @brief Class handling the different types of dofs
*
* @section LICENSE
*
* Copyright (©) 2010-2011 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 "aka_memory.hh"
#include "non_linear_solver.hh"
#include "time_step_solver.hh"
/* -------------------------------------------------------------------------- */
#include <map>
/* -------------------------------------------------------------------------- */
#ifndef __AKANTU_DOF_MANAGER_HH__
#define __AKANTU_DOF_MANAGER_HH__
namespace akantu {
class NonLinearSolverCallback;
class SparseMatrixAIJ;
}
__BEGIN_AKANTU__
class DOFManager : protected Memory {
/* ------------------------------------------------------------------------ */
/* Constructors/Destructors */
/* ------------------------------------------------------------------------ */
public:
DOFManager(const Mesh & mesh, const ID & id = "dof_manager",
const MemoryID & memory_id = 0);
virtual ~DOFManager();
/* ------------------------------------------------------------------------ */
/* Methods */
/* ------------------------------------------------------------------------ */
public:
/// register an array of degree of freedom
void registerDOFs(const ID & dof_id, Array<Real> & dofs_array,
const DOFSupportType & support_type);
/// register an array of derivatives for a particular dof array
void registerDOFsDerivative(const ID & dof_id, UInt order,
Array<Real> & dofs_derivative);
/// register array representing the blocked degree of freedoms
void registerBlockedDOFs(const ID & dof_id, Array<bool> & blocked_dofs);
/// Assemble an array to the global residual array
virtual void assembleToResidual(const ID & dof_id,
const Array<Real> & array_to_assemble,
Real scale_factor = 1.) = 0;
/**
* Assemble elementary values to a local array of the size nb_nodes *
* nb_dof_per_node. The dof number is implicitly considered as
* conn(el, n) * nb_nodes_per_element + d.
* With 0 < n < nb_nodes_per_element and 0 < d < nb_dof_per_node
**/
virtual void assembleElementalArrayLocalArray(
const Array<Real> & elementary_vect, Array<Real> & array_assembeled,
const ElementType & type, const GhostType & ghost_type,
Real scale_factor = 1.,
const Array<UInt> & filter_elements = empty_filter);
/**
* Assemble elementary values to the global residual array. The dof number is
* implicitly considered as conn(el, n) * nb_nodes_per_element + d.
* With 0 < n < nb_nodes_per_element and 0 < d < nb_dof_per_node
**/
virtual void assembleElementalArrayResidual(
const ID & dof_id, const Array<Real> & elementary_vect,
const ElementType & type, const GhostType & ghost_type,
Real scale_factor = 1.,
const Array<UInt> & filter_elements = empty_filter);
/**
* Assemble elementary values to the global residual array. The dof number is
* implicitly considered as conn(el, n) * nb_nodes_per_element + d. With 0 <
* n < nb_nodes_per_element and 0 < d < nb_dof_per_node
**/
virtual void assembleElementalMatricesToMatrix(
const ID & matrix_id, const ID & dof_id,
const Array<Real> & elementary_mat, const ElementType & type,
const GhostType & ghost_type,
const MatrixType & elemental_matrix_type = _symmetric,
const Array<UInt> & filter_elements = empty_filter) = 0;
/// notation fully defined yet...
// virtual void assemblePreassembledMatrix(const ID & matrix_id,
// const ID & dof_id_m,
// const ID & dof_id_n,
// const Matrix<Real> & matrix) = 0;
/// function to print the contain of the class
virtual void printself(std::ostream & stream, int indent = 0) const;
protected:
/// splits the solution storage from a global view to the per dof storages
void splitSolutionPerDOFs();
/// minimum fonctionality to implement per derived version of the DOFManager
/// to allow the splitSolutionPerDOFs function to work
virtual void getSolutionPerDOFs(const ID & dof_id,
Array<Real> & solution_array) = 0;
/// fill a Vector with the equation numbers corresponding to the given
/// connectivity
inline void extractElementEquationNumber(
const Array<UInt> & equation_numbers, const Vector<UInt> & connectivity,
UInt nb_degree_of_freedom, Vector<UInt> & local_equation_number);
/// register a matrix
void registerSparseMatrix(const ID & matrix_id, SparseMatrix & matrix);
/// register a time step solver instantiated by a derived class
void registerTimeStepSolver(const ID & time_step_solver_id,
TimeStepSolver & time_step_solver);
/* ------------------------------------------------------------------------ */
/* Accessors */
/* ------------------------------------------------------------------------ */
public:
/// get the equation numbers (in local numbering) corresponding to a dof ID
Array<UInt> & getLocalEquationNumbers(const ID & dof_id);
/// get the equation numbers (in global numbering) corresponding to a dof ID
Array<UInt> & getGlobalEquationNumbers(const ID & dof_id);
/// get the local equation number corresponding to the global equation number
/// get the equation numbers (in local numbering) corresponding to a dof ID
const Array<UInt> & getLocalEquationNumbers(const ID & dof_id) const;
/// get the equation numbers (in global numbering) corresponding to a dof ID
const Array<UInt> & getGlobalEquationNumbers(const ID & dof_id) const;
/// Global number of dofs
AKANTU_GET_MACRO(SystemSize, this->system_size, UInt);
/// Local number of dofs
AKANTU_GET_MACRO(LocalSystemSize, this->local_system_size, UInt);
/// Get the solver callback stored in the dof_manager
AKANTU_GET_MACRO(SolverCallback, *solver_callback, NonLinearSolverCallback &);
/* ------------------------------------------------------------------------ */
/* DOFs and derivatives accessors */
/* ------------------------------------------------------------------------ */
/// Get a reference to the registered dof array for a given id
Array<Real> & getDOFs(const ID & dofs_id);
/// Get a reference to the registered dof derivatives array for a given id
Array<Real> & getDOFsDerivatives(const ID & dofs_id, UInt order);
// /// Get a reference to the blocked dofs array registered for the given id
// Array<bool> & getBlockedDOFs(const ID & dofs_id);
/// Get a reference to the blocked dofs array registered for the given id
const Array<bool> & getBlockedDOFs(const ID & dofs_id) const;
/// Get a reference to the solution array registered for the given id
const Array<Real> & getSolution(const ID & dofs_id) const;
// /// Get a reference to the right hand side array registered for the given
// dof
// /// id
// const Array<Real> & getRHS() const;
/* ------------------------------------------------------------------------ */
/* Matrices accessors */
/* ------------------------------------------------------------------------ */
/// Get an instance of a new SparseMatrix
virtual SparseMatrix & getNewMatrix(const ID & matrix_id,
const MatrixType & matrix_type);
/// Get an instance of a new SparseMatrix as a copy of the SparseMatrix
/// matrix_to_copy_id
virtual SparseMatrix & getNewMatrix(const ID & matrix_id,
const ID & matrix_to_copy_id);
/// Get the reference of an existing matrix
SparseMatrix & getMatrix(const ID & matrix_id);
/* ------------------------------------------------------------------------ */
/* Non linear system solver */
/* ------------------------------------------------------------------------ */
/// Get instance of a non linear solver
virtual NonLinearSolver &
getNewNonLinearSolver(const ID & nls_solver_id,
const NonLinearSolverType & _non_linear_solver_type);
/// get instance of a non linear solver
virtual NonLinearSolver & getNonLinearSolver(const ID & nls_solver_id);
/* ------------------------------------------------------------------------ */
/* TimeStepSolver */
/* ------------------------------------------------------------------------ */
/// Get instance of a time step solver
virtual TimeStepSolver &
getNewTimeStepSolver(const ID & time_step_solver_id, const ID & dof_id,
const TimeStepSolverType & type);
/// get instance of a time step solver
virtual TimeStepSolver & getTimeStepSolver(const ID & time_step_solver_id);
/* ------------------------------------------------------------------------*/
/* Class Members */
/* ------------------------------------------------------------------------*/
protected:
/// dof representations in the dof manager
struct DOFData {
/// DOF support type (nodal, general) this is needed to determine how the
/// dof are shared among processors
DOFSupportType support_type;
/// Degree of freedom array
Array<Real> * dof;
/// Blocked degree of freedoms array
Array<bool> * blocked_dofs;
/// Solution associated to the dof
Array<Real> * solution;
/* ---------------------------------------------------------------------- */
/* data for dynamic simulations */
/* ---------------------------------------------------------------------- */
/// Degree of freedom derivatives arrays
std::vector<Array<Real> *> dof_derivatives;
/// local numbering equation numbers
Array<UInt> local_equation_number;
};
/// equation number in global numbering
Array<UInt> global_equation_number;
/// type to store dofs informations
typedef std::map<ID, DOFData *> DOFStorage;
/// type to store all the matrices
typedef std::map<ID, SparseMatrix *> SparseMatricesMap;
/// type to store all the non linear solver
typedef std::map<ID, NonLinearSolver *> NonLinearSolversMap;
/// type to store all the time step solver
typedef std::map<ID, TimeStepSolver *> TimeStepSolversMap;
/// store a reference to the dof arrays
DOFStorage dofs;
/// list of sparse matrices that where created
SparseMatricesMap matrices;
/// non linear solvers storage
NonLinearSolversMap non_linear_solvers;
/// time step solvers storage
TimeStepSolversMap time_step_solvers;
/// reference to the underlying mesh
const Mesh & mesh;
/// Solver callback to assemble residual and Jacobian matrix
NonLinearSolverCallback * solver_callback;
/// Total number of degrees of freedom (size with the ghosts)
UInt local_system_size;
/// Number of purely local dofs (size without the ghosts)
UInt pure_local_system_size;
/// Total number of degrees of freedom
UInt system_size;
};
__END_AKANTU__
#include "dof_manager_inline_impl.cc"
#endif /* __AKANTU_DOF_MANAGER_HH__ */
c4science · Help