Abstract constraint class.
More...
#include <constraint.hpp>
|
|
| Constraint (const std::string &name="constraint") |
| | base constructor takes the name of the physics
|
| |
|
virtual | ~Constraint () |
| | destructor
|
| |
| virtual mfem::Vector | evaluate (double time, double dt, const std::vector< ConstFieldPtr > &fields) const =0 |
| | Virtual interface for computing the constraint, given a vector of smith::FiniteElementState*. More...
|
| |
| virtual std::unique_ptr< mfem::HypreParMatrix > | jacobian (double time, double dt, const std::vector< ConstFieldPtr > &fields, int direction) const =0 |
| | Virtual interface for computing constraint Jacobian from a vector of smith::FiniteElementState*. More...
|
| |
| virtual std::unique_ptr< mfem::HypreParMatrix > | jacobian_tilde (double time, double dt, const std::vector< ConstFieldPtr > &fields, int direction) const |
| | Virtual interface for computing constraint Jacobian_tilde from a vector of smith::FiniteElementState* Jacobian_tilde is an optional approximation of the true Jacobian. More...
|
| |
| virtual mfem::Vector | residual_contribution (double time, double dt, const std::vector< ConstFieldPtr > &fields, const mfem::Vector &multipliers, int direction) const |
| | Virtual interface for computing residual contribution Jacobian_tilde^T multiplier from a vector of smith::FiniteElementState*. More...
|
| |
| virtual std::unique_ptr< mfem::HypreParMatrix > | residual_contribution_jacobian ([[maybe_unused]] double time, [[maybe_unused]] double dt, [[maybe_unused]] const std::vector< ConstFieldPtr > &fields, [[maybe_unused]] const mfem::Vector &multipliers, [[maybe_unused]] int direction) const |
| | Virtual interface for computing Jacobians of the residual contribution from a vector of smith::FiniteElementState*. More...
|
| |
|
std::string | name () const |
| | name
|
| |
Abstract constraint class.
Definition at line 30 of file constraint.hpp.
◆ evaluate()
| virtual mfem::Vector smith::Constraint::evaluate |
( |
double |
time, |
|
|
double |
dt, |
|
|
const std::vector< ConstFieldPtr > & |
fields |
|
) |
| const |
|
pure virtual |
Virtual interface for computing the constraint, given a vector of smith::FiniteElementState*.
- Parameters
-
- Returns
- mfem::Vector which is the constraint evaluation
◆ jacobian()
| virtual std::unique_ptr<mfem::HypreParMatrix> smith::Constraint::jacobian |
( |
double |
time, |
|
|
double |
dt, |
|
|
const std::vector< ConstFieldPtr > & |
fields, |
|
|
int |
direction |
|
) |
| const |
|
pure virtual |
Virtual interface for computing constraint Jacobian from a vector of smith::FiniteElementState*.
- Parameters
-
| time | time |
| dt | time step |
| fields | vector of smith::FiniteElementState* |
| direction | index for which field to take the gradient with respect to |
- Returns
- std::unique_ptr<mfem::HypreParMatrix>
◆ jacobian_tilde()
| virtual std::unique_ptr<mfem::HypreParMatrix> smith::Constraint::jacobian_tilde |
( |
double |
time, |
|
|
double |
dt, |
|
|
const std::vector< ConstFieldPtr > & |
fields, |
|
|
int |
direction |
|
) |
| const |
|
inlinevirtual |
Virtual interface for computing constraint Jacobian_tilde from a vector of smith::FiniteElementState* Jacobian_tilde is an optional approximation of the true Jacobian.
- Parameters
-
| time | time |
| dt | time step |
| fields | vector of smith::FiniteElementState* |
| direction | index for which field to take the gradient with respect to |
- Returns
- std::unique_ptr<mfem::HypreParMatrix>
Definition at line 69 of file constraint.hpp.
◆ residual_contribution()
| virtual mfem::Vector smith::Constraint::residual_contribution |
( |
double |
time, |
|
|
double |
dt, |
|
|
const std::vector< ConstFieldPtr > & |
fields, |
|
|
const mfem::Vector & |
multipliers, |
|
|
int |
direction |
|
) |
| const |
|
inlinevirtual |
Virtual interface for computing residual contribution Jacobian_tilde^T multiplier from a vector of smith::FiniteElementState*.
- Parameters
-
| time | time |
| dt | time step |
| fields | vector of smith::FiniteElementState* |
| multipliers | mfem::Vector of Lagrange multipliers |
| direction | index for which field to take the gradient with respect to |
- Returns
- std::Vector
Definition at line 86 of file constraint.hpp.
◆ residual_contribution_jacobian()
| virtual std::unique_ptr<mfem::HypreParMatrix> smith::Constraint::residual_contribution_jacobian |
( |
[[maybe_unused] ] double |
time, |
|
|
[[maybe_unused] ] double |
dt, |
|
|
[[maybe_unused] ] const std::vector< ConstFieldPtr > & |
fields, |
|
|
[[maybe_unused] ] const mfem::Vector & |
multipliers, |
|
|
[[maybe_unused] ] int |
direction |
|
) |
| const |
|
inlinevirtual |
Virtual interface for computing Jacobians of the residual contribution from a vector of smith::FiniteElementState*.
- Parameters
-
| time | time |
| dt | time step |
| fields | vector of smith::FiniteElementState* |
| multipliers | mfem::Vector of Lagrange multipliers |
| direction | index for which field to take the gradient with respect to |
- Returns
- std::unique_ptr<mfem::HypreParMatrix>
Definition at line 107 of file constraint.hpp.
The documentation for this class was generated from the following file:
