IdentityMatrix
Represents the identity matrix function .
Defined in Rodin/Variational/IdentityMatrix.h
class IdentityMatrix;
This class represents the matrix function that returns the dimensional identity matrix at each point:
Commonly used in finite element formulations for identity operators or as a reference configuration.
Inherits from
| Base class | Responsibility |
|---|---|
MatrixFunctionBase<Real, IdentityMatrix>publicFull typeMatrixFunctionBase< Real, IdentityMatrix > | Base class for matrix-valued functions defined on a mesh. |
Overrides
| Member | Base declaration |
|---|---|
copy() | MatrixFunctionBase::copy |
Inherited interface
| Declared in | Members |
|---|---|
FunctionBase | |
FormLanguage::Base | 3 members |
Identifiable | |
MatrixFunctionBase |
Public types
- using ScalarType = Real
- Scalar value type.
- using Parent = MatrixFunctionBase<ScalarType, IdentityMatrix>
- Parent class type.
Constructors, destructors, conversion operators
- IdentityMatrix(size_t n)
- Constructs the identity matrix function.
- IdentityMatrix(const IdentityMatrix& other)
- Copy constructor.
- IdentityMatrix(IdentityMatrix&& other)
- Move constructor.
Public functions
- auto getRows() const -> size_t
- Gets number of rows.
- auto getColumns() const -> size_t
- Gets number of columns.
-
auto getValue(const Geometry::
Point& point) const -> Math:: SpatialMatrix<Real> - Evaluates the identity matrix at a point.
-
auto getOrder(const Geometry::
Polytope& polytope) const -> Optional<size_t> constexpr noexcept - Returns the polynomial order used on a mesh entity.
- auto copy() const -> IdentityMatrix* override noexcept
- Creates a polymorphic copy of the identity matrix.
Function documentation
IdentityMatrix(size_t n)
Constructs the identity matrix function.
| Parameters | |
|---|---|
| n | Dimension of identity matrix |
IdentityMatrix(const IdentityMatrix& other)
Copy constructor.
| Parameters | |
|---|---|
| other | Identity matrix to copy |
Math:: SpatialMatrix<Real> getValue(const Geometry:: Point& point) const
Evaluates the identity matrix at a point.
| Parameters | |
|---|---|
| point | Evaluation point; the result is independent of this argument. |
| Returns | Identity matrix |
Optional<size_t> getOrder(const Geometry:: Polytope& polytope) const constexpr noexcept
Returns the polynomial order used on a mesh entity.
| Parameters | |
|---|---|
| polytope | Mesh entity; the reported order is independent of this argument. |
| Returns | Polynomial order on the entity, or an empty optional when no order is available. |
IdentityMatrix* copy() const override noexcept
Creates a polymorphic copy of the identity matrix.
| Returns | Pointer to copy |
|---|