|
| v0.14.0
|
Calculate directional derivative of the right hand side and compare it with tangent matrix derivative.
More...
#include <src/interfaces/OperatorsTester.hpp>
|
MoFEMErrorCode | query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const |
|
| OperatorsTester (const MoFEM::Core &core) |
|
virtual | ~OperatorsTester ()=default |
|
SmartPetscObj< Vec > | setRandomFields (SmartPetscObj< DM > dm, std::vector< RandomFieldData > random_fields, boost::shared_ptr< Range > ents=nullptr) |
| Generate random fileds. More...
|
|
SmartPetscObj< Vec > | assembleVec (SmartPetscObj< DM > dm, std::string fe_name, boost::shared_ptr< FEMethod > pipeline, SmartPetscObj< Vec > x, SmartPetscObj< Vec > delta_x, SmartPetscObj< Vec > delta2_x, double time, double delta_t, CacheTupleWeakPtr cache_ptr) |
| Assemble the right hand side vector. More...
|
|
SmartPetscObj< Mat > | assembleMat (SmartPetscObj< DM > dm, std::string fe_name, boost::shared_ptr< FEMethod > pipeline, SmartPetscObj< Vec > x, SmartPetscObj< Vec > delta_x, SmartPetscObj< Vec > delta2_x, double time, double delta_t, CacheTupleWeakPtr cache_ptr) |
| Assemble the left hand side vector. More...
|
|
SmartPetscObj< Vec > | directionalCentralFiniteDifference (SmartPetscObj< DM > dm, std::string fe_name, boost::shared_ptr< FEMethod > pipeline, SmartPetscObj< Vec > x, SmartPetscObj< Vec > delta_x, SmartPetscObj< Vec > delta2_x, SmartPetscObj< Vec > diff_x, double time, double delta_t, double eps, CacheTupleWeakPtr cache_ptr=CacheTupleSharedPtr()) |
| Calculate directional directive using finite difference. More...
|
|
SmartPetscObj< Vec > | checkCentralFiniteDifference (SmartPetscObj< DM > dm, std::string fe_name, boost::shared_ptr< FEMethod > pipeline_rhs, boost::shared_ptr< FEMethod > pipeline_lhs, SmartPetscObj< Vec > x, SmartPetscObj< Vec > delta_x, SmartPetscObj< Vec > delta2_x, SmartPetscObj< Vec > diff_x, double time, double delta_t, double eps, CacheTupleWeakPtr cache_ptr=CacheTupleSharedPtr()) |
| Check consistency between directional derivative with matrix. More...
|
|
template<class IFACE > |
MoFEMErrorCode | registerInterface (bool error_if_registration_failed=true) |
| Register interface. More...
|
|
template<class IFACE > |
MoFEMErrorCode | getInterface (IFACE *&iface) const |
| Get interface reference to pointer of interface. More...
|
|
template<class IFACE > |
MoFEMErrorCode | getInterface (IFACE **const iface) const |
| Get interface pointer to pointer of interface. More...
|
|
template<class IFACE , typename boost::enable_if< boost::is_pointer< IFACE >, int >::type = 0> |
IFACE | getInterface () const |
| Get interface pointer to pointer of interface. More...
|
|
template<class IFACE , typename boost::enable_if< boost::is_reference< IFACE >, int >::type = 0> |
IFACE | getInterface () const |
| Get reference to interface. More...
|
|
template<class IFACE > |
IFACE * | getInterface () const |
| Function returning pointer to interface. More...
|
|
virtual | ~UnknownInterface ()=default |
|
Calculate directional derivative of the right hand side and compare it with tangent matrix derivative.
- Examples
- free_surface.cpp, level_set.cpp, operators_tests.cpp, and tensor_divergence_operator.cpp.
Definition at line 21 of file OperatorsTester.hpp.
◆ RandomFieldData
◆ OperatorsTester()
MoFEM::OperatorsTester::OperatorsTester |
( |
const MoFEM::Core & |
core | ) |
|
◆ ~OperatorsTester()
virtual MoFEM::OperatorsTester::~OperatorsTester |
( |
| ) |
|
|
virtualdefault |
◆ assembleMat()
Assemble the left hand side vector.
- Parameters
-
dm | |
fe_name | // fe name |
pipeline | // pipeline, i.e. fe instance |
x | // problem (dm) vector |
delta_x | // vector for x rate, can be null, i.e, SmartPetscObj<Vec>() |
delta2_x | // vector for x second rate, i.e. acceleration |
time | // time |
delta_t | // time increment |
cache_ptr | // finite element data cache, can be null |
- Returns
- SmartPetscObj<Vec>
Definition at line 120 of file OperatorsTester.cpp.
132 pipeline->ts_t = time;
134 pipeline->ts_dt = delta_t;
135 pipeline->ts_a = 1. / delta_t;
136 pipeline->ts_aa = 1. / pow(delta_t, 2);
138 auto [
v,
a] =
setPipelineX(pipeline, x, delta_x, delta2_x, delta_t);
146 "Run assemble pipeline");
◆ assembleVec()
Assemble the right hand side vector.
- Parameters
-
dm | |
fe_name | // fe name |
pipeline | // pipeline, i.e. fe instance |
x | // problem (dm) vector |
delta_x | // vector for x rate, can be null, i.e, SmartPetscObj<Vec>() |
delta2_x | // vector for x second rate, i.e. acceleration |
time | // time |
delta_t | // time increment |
cache_ptr | // finite element data cache, can be null |
- Returns
- SmartPetscObj<Vec>
Definition at line 83 of file OperatorsTester.cpp.
92 pipeline->ts_t = time;
93 pipeline->ts_dt = delta_t;
95 auto [
v,
a] =
setPipelineX(pipeline, x, delta_x, delta2_x, delta_t);
103 "Run assemble pipeline");
◆ checkCentralFiniteDifference()
SmartPetscObj< Vec > MoFEM::OperatorsTester::checkCentralFiniteDifference |
( |
SmartPetscObj< DM > |
dm, |
|
|
std::string |
fe_name, |
|
|
boost::shared_ptr< FEMethod > |
pipeline_rhs, |
|
|
boost::shared_ptr< FEMethod > |
pipeline_lhs, |
|
|
SmartPetscObj< Vec > |
x, |
|
|
SmartPetscObj< Vec > |
delta_x, |
|
|
SmartPetscObj< Vec > |
delta2_x, |
|
|
SmartPetscObj< Vec > |
diff_x, |
|
|
double |
time, |
|
|
double |
delta_t, |
|
|
double |
eps, |
|
|
CacheTupleWeakPtr |
cache_ptr = CacheTupleSharedPtr() |
|
) |
| |
Check consistency between directional derivative with matrix.
- Parameters
-
dm | |
fe_name | |
pipeline_rhs | |
pipeline_lhs | |
x | |
delta_x | |
delta2_x | |
diff_x | |
time | |
delta_t | |
eps | |
cache_ptr | |
- Returns
- SmartPetscObj<Vec>
Definition at line 210 of file OperatorsTester.cpp.
219 dm, fe_name, pipeline_rhs, x, delta_x, delta2_x, diff_x, time, delta_t,
222 auto m =
assembleMat(dm, fe_name, pipeline_lhs, x, delta_x, delta2_x, time,
◆ directionalCentralFiniteDifference()
SmartPetscObj< Vec > MoFEM::OperatorsTester::directionalCentralFiniteDifference |
( |
SmartPetscObj< DM > |
dm, |
|
|
std::string |
fe_name, |
|
|
boost::shared_ptr< FEMethod > |
pipeline, |
|
|
SmartPetscObj< Vec > |
x, |
|
|
SmartPetscObj< Vec > |
delta_x, |
|
|
SmartPetscObj< Vec > |
delta2_x, |
|
|
SmartPetscObj< Vec > |
diff_x, |
|
|
double |
time, |
|
|
double |
delta_t, |
|
|
double |
eps, |
|
|
CacheTupleWeakPtr |
cache_ptr = CacheTupleSharedPtr() |
|
) |
| |
Calculate directional directive using finite difference.
- Parameters
-
dm | |
fe_name | |
pipeline | |
x | |
delta_x | |
delta2_x | |
diff_x | // direction of derivative |
time | |
delta_t | |
eps | |
cache_ptr | |
- Returns
- SmartPetscObj<Vec>
Definition at line 153 of file OperatorsTester.cpp.
160 auto axpy = [&](
auto v0,
auto diff_v,
auto eps) {
161 SmartPetscObj<Vec>
v;
162 if (v0.use_count()) {
176 axpy(x, diff_x, -
eps),
178 axpy(delta_x, diff_x, -
eps),
180 axpy(delta2_x, diff_x, -
eps),
182 time, delta_t, cache_ptr);
186 axpy(x, diff_x,
eps),
188 axpy(delta_x, diff_x,
eps),
190 axpy(delta2_x, diff_x,
eps),
192 time, delta_t, cache_ptr);
194 auto calculate_derivative = [
eps](
auto fm1,
auto fp1) {
196 VecGetLocalSize(fp1, &size);
197 VecAXPY(fp1, -1, fm1);
199 VecGetArray(fp1, &array);
200 for (
int j = 0;
j != size; ++
j) {
203 VecRestoreArray(fp1, &array);
207 return calculate_derivative(fm1, fp1);
◆ query_interface()
◆ setPipelineX()
Set vectors, x, x_t, and x_tt to finite element instance.
Finite element instance is a pipeline. x_t and x_tt are evaluated for given delta_x, delta2_x and delta_t.
- Parameters
-
pipeline | |
x | |
delta_x | |
delta2_x | |
delta_t | |
- Returns
- std::pair<SmartPetscObj<Vec>, SmartPetscObj<Vec>>
Definition at line 233 of file OperatorsTester.cpp.
242 SmartPetscObj<Vec> x_t, x_tt;
248 VecCopy(delta_x, x_t);
249 VecScale(x_t, 1. / delta_t);
257 pipeline->x_t = PETSC_NULL;
264 VecCopy(delta2_x, x_tt);
265 VecScale(x_tt, 1. / pow(delta_t, 2));
270 pipeline->x_tt = x_tt;
273 pipeline->x_tt = PETSC_NULL;
276 return std::make_pair(x_t, x_tt);
◆ setRandomFields()
Generate random fileds.
Example: generate random vector for DM (problem) from simple interface, where FIELD random values of DOFs are in range from -1 to 1, and FIELD2 random values are in range from 0 to 1.
auto x = opt->setRandomFields(
simple->getDM(),
{{"FIELD1", {-1, 1}}, {"FIELD2", {0,1}}});
TODO: Set random field to specific entities, and potentially order for testing proposes to dissect error in tangent matrix.
- Parameters
-
- Returns
- SmartPetscObj<Vec> smart vector
- Examples
- tensor_divergence_operator.cpp.
Definition at line 24 of file OperatorsTester.cpp.
32 auto get_random_number = [](
auto &range) {
33 const auto r =
static_cast<double>(std::rand()) / RAND_MAX;
34 return range[0] +
r * (range[1] - range[0]);
43 for (
auto &rf : random_fields) {
46 <<
"Set random field " << rf.first <<
" " <<
static_cast<int>(field_id);
49 auto lo = prb_ptr->getNumeredRowDofsPtr()->lower_bound(
51 const auto hi = prb_ptr->getNumeredRowDofsPtr()->upper_bound(
53 for (; lo != hi; ++lo) {
54 const auto idx = (*lo)->getPetscLocalDofIdx();
55 array[idx] = get_random_number(rf.second);
58 for (
auto pit = ents_ptr->const_pair_begin();
59 pit != ents_ptr->const_pair_end(); ++pit) {
61 prb_ptr->getNumeredRowDofsPtr()->get<Unique_mi_tag>().lower_bound(
64 prb_ptr->getNumeredRowDofsPtr()->get<Unique_mi_tag>().upper_bound(
66 for (; lo != hi; ++lo) {
67 const auto idx = (*lo)->getPetscLocalDofIdx();
68 array[idx] = get_random_number(rf.second);
74 CHKERR VecRestoreArray(
v, &array);
76 CHKERR VecGhostUpdateBegin(
v, INSERT_VALUES, SCATTER_FORWARD);
77 CHKERR VecGhostUpdateEnd(
v, INSERT_VALUES, SCATTER_FORWARD);
◆ cOre
The documentation for this struct was generated from the following files:
OperatorsTester(const MoFEM::Core &core)
#define MOFEM_LOG_CHANNEL(channel)
Set and reset channel.
static constexpr Switches CtxSetB
static constexpr Switches CtxSetA
#define CHK_THROW_MESSAGE(err, msg)
Check and throw MoFEM exception.
virtual FieldBitNumber get_field_bit_number(const std::string name) const =0
get field bit number
std::pair< SmartPetscObj< Vec >, SmartPetscObj< Vec > > setPipelineX(boost::shared_ptr< FEMethod > pipeline, SmartPetscObj< Vec > x, SmartPetscObj< Vec > delta_x, SmartPetscObj< Vec > delta2_x, double delta_t)
Set vectors, x, x_t, and x_tt to finite element instance.
PetscErrorCode DMoFEMMeshToLocalVector(DM dm, Vec l, InsertMode mode, ScatterMode scatter_mode)
set local (or ghosted) vector values on mesh for partition only
auto createDMMatrix(DM dm)
Get smart matrix from DM.
Deprecated interface functions.
SmartPetscObj< Mat > assembleMat(SmartPetscObj< DM > dm, std::string fe_name, boost::shared_ptr< FEMethod > pipeline, SmartPetscObj< Vec > x, SmartPetscObj< Vec > delta_x, SmartPetscObj< Vec > delta2_x, double time, double delta_t, CacheTupleWeakPtr cache_ptr)
Assemble the left hand side vector.
#define CHKERR
Inline error check.
auto createDMVector(DM dm)
Get smart vector from DM.
void simple(double P1[], double P2[], double P3[], double c[], const int N)
static UId getLoBitNumberUId(const FieldBitNumber bit_number)
static constexpr Switches CtxSetTime
SmartPetscObj< Vec > directionalCentralFiniteDifference(SmartPetscObj< DM > dm, std::string fe_name, boost::shared_ptr< FEMethod > pipeline, SmartPetscObj< Vec > x, SmartPetscObj< Vec > delta_x, SmartPetscObj< Vec > delta2_x, SmartPetscObj< Vec > diff_x, double time, double delta_t, double eps, CacheTupleWeakPtr cache_ptr=CacheTupleSharedPtr())
Calculate directional directive using finite difference.
static UId getLoFieldEntityUId(const FieldBitNumber bit, const EntityHandle ent)
const double v
phase velocity of light in medium (cm/ns)
#define MOFEM_TAG_AND_LOG(channel, severity, tag)
Tag and log in channel.
SmartPetscObj< Vec > vectorDuplicate(Vec vec)
Create duplicate vector of smart vector.
SmartPetscObj< Vec > assembleVec(SmartPetscObj< DM > dm, std::string fe_name, boost::shared_ptr< FEMethod > pipeline, SmartPetscObj< Vec > x, SmartPetscObj< Vec > delta_x, SmartPetscObj< Vec > delta2_x, double time, double delta_t, CacheTupleWeakPtr cache_ptr)
Assemble the right hand side vector.
static UId getHiFieldEntityUId(const FieldBitNumber bit, const EntityHandle ent)
FTensor::Index< 'j', 3 > j
auto getProblemPtr(DM dm)
get problem pointer from DM
static UId getHiBitNumberUId(const FieldBitNumber bit_number)
FTensor::Index< 'm', 3 > m
static constexpr Switches CtxSetF
PetscErrorCode DMoFEMLoopFiniteElements(DM dm, const char fe_name[], MoFEM::FEMethod *method, CacheTupleWeakPtr cache_ptr=CacheTupleSharedPtr())
Executes FEMethod for finite elements in DM.