libMesh
Loading...
Searching...
No Matches
Functions
introduction_ex4.C File Reference

Go to the source code of this file.

Functions

void assemble_poisson (EquationSystems &es, const std::string &system_name)
 
Real exact_solution (const Real x, const Real y, const Real z=0.)
 This is the exact solution that we are trying to obtain.
 
void exact_solution_wrapper (DenseVector< Number > &output, const Point &p, const Real)
 
int main (int argc, char **argv)
 
void assemble_poisson (EquationSystems &es, const std::string &libmesh_dbg_var(system_name))
 

Function Documentation

◆ assemble_poisson() [1/2]

void assemble_poisson ( EquationSystems es,
const std::string &  libmesh_dbg_varsystem_name 
)

Definition at line 313 of file introduction_ex4.C.

315{
316 // It is a good idea to make sure we are assembling
317 // the proper system.
318 libmesh_assert_equal_to (system_name, "Poisson");
319
320 // Declare a performance log. Give it a descriptive
321 // string to identify what part of the code we are
322 // logging, since there may be many PerfLogs in an
323 // application.
324 PerfLog perf_log ("Matrix Assembly");
325
326 // Get a constant reference to the mesh object.
327 const MeshBase & mesh = es.get_mesh();
328
329 // The dimension that we are running
330 const unsigned int dim = mesh.mesh_dimension();
331
332 // Get a reference to the LinearImplicitSystem we are solving
333 LinearImplicitSystem & system = es.get_system<LinearImplicitSystem>("Poisson");
334
335 // A reference to the DofMap object for this system. The DofMap
336 // object handles the index translation from node and element numbers
337 // to degree of freedom numbers. We will talk more about the DofMap
338 // in future examples.
339 const DofMap & dof_map = system.get_dof_map();
340
341 // Get a constant reference to the Finite Element type
342 // for the first (and only) variable in the system.
343 FEType fe_type = dof_map.variable_type(0);
344
345 // Build a Finite Element object of the specified type. Since the
346 // FEBase::build() member dynamically creates memory we will
347 // store the object as a std::unique_ptr<FEBase>. This can be thought
348 // of as a pointer that will clean up after itself.
349 std::unique_ptr<FEBase> fe (FEBase::build(dim, fe_type));
350
351 // A 5th order Gauss quadrature rule for numerical integration.
352 QGauss qrule (dim, FIFTH);
353
354 // Tell the finite element object to use our quadrature rule.
355 fe->attach_quadrature_rule (&qrule);
356
357 // Declare a special finite element object for
358 // boundary integration.
359 std::unique_ptr<FEBase> fe_face (FEBase::build(dim, fe_type));
360
361 // Boundary integration requires one quadrature rule,
362 // with dimensionality one less than the dimensionality
363 // of the element.
364 QGauss qface(dim-1, FIFTH);
365
366 // Tell the finite element object to use our
367 // quadrature rule.
368 fe_face->attach_quadrature_rule (&qface);
369
370 // Here we define some references to cell-specific data that
371 // will be used to assemble the linear system.
372 // We begin with the element Jacobian * quadrature weight at each
373 // integration point.
374 const std::vector<Real> & JxW = fe->get_JxW();
375
376 // The physical XY locations of the quadrature points on the element.
377 // These might be useful for evaluating spatially varying material
378 // properties at the quadrature points.
379 const std::vector<Point> & q_point = fe->get_xyz();
380
381 // The element shape functions evaluated at the quadrature points.
382 const std::vector<std::vector<Real>> & phi = fe->get_phi();
383
384 // The element shape function gradients evaluated at the quadrature
385 // points.
386 const std::vector<std::vector<RealGradient>> & dphi = fe->get_dphi();
387
388 // Define data structures to contain the element matrix
389 // and right-hand-side vector contribution. Following
390 // basic finite element terminology we will denote these
391 // "Ke" and "Fe". More detail is in example 3.
394
395 // This vector will hold the degree of freedom indices for
396 // the element. These define where in the global system
397 // the element degrees of freedom get mapped.
398 std::vector<dof_id_type> dof_indices;
399
400 // The global system matrix
401 SparseMatrix<Number> & matrix = system.get_system_matrix();
402
403 // Now we will loop over all the elements in the mesh.
404 // We will compute the element matrix and right-hand-side
405 // contribution. See example 3 for a discussion of the
406 // element iterators.
407 for (const auto & elem : mesh.active_local_element_ptr_range())
408 {
409 // Start logging the shape function initialization.
410 // This is done through a simple function call with
411 // the name of the event to log.
412 perf_log.push("elem init");
413
414 // Get the degree of freedom indices for the
415 // current element. These define where in the global
416 // matrix and right-hand-side this element will
417 // contribute to.
418 dof_map.dof_indices (elem, dof_indices);
419
420 // Cache the number of degrees of freedom on this element, for
421 // use as a loop bound later. We use cast_int to explicitly
422 // convert from size() (which may be 64-bit) to unsigned int
423 // (which may be 32-bit but which is definitely enough to count
424 // *local* degrees of freedom.
425 const unsigned int n_dofs =
426 cast_int<unsigned int>(dof_indices.size());
427
428 // Compute the element-specific data for the current
429 // element. This involves computing the location of the
430 // quadrature points (q_point) and the shape functions
431 // (phi, dphi) for the current element.
432 fe->reinit (elem);
433
434 // With one variable, we should have the same number of degrees
435 // of freedom as shape functions.
436 libmesh_assert_equal_to (n_dofs, phi.size());
437
438 // Zero the element matrix and right-hand side before
439 // summing them. We use the resize member here because
440 // the number of degrees of freedom might have changed from
441 // the last element. Note that this will be the case if the
442 // element type is different (i.e. the last element was a
443 // triangle, now we are on a quadrilateral).
444 Ke.resize (n_dofs, n_dofs);
445
446 Fe.resize (n_dofs);
447
448 // Stop logging the shape function initialization.
449 // If you forget to stop logging an event the PerfLog
450 // object will probably catch the error and abort.
451 perf_log.pop("elem init");
452
453 // Now we will build the element matrix. This involves
454 // a double loop to integrate the test functions (i) against
455 // the trial functions (j).
456 //
457 // We have split the numeric integration into two loops
458 // so that we can log the matrix and right-hand-side
459 // computation separately.
460 //
461 // Now start logging the element matrix computation
462 perf_log.push ("Ke");
463
464 for (unsigned int qp=0; qp<qrule.n_points(); qp++)
465 for (unsigned int i=0; i != n_dofs; i++)
466 for (unsigned int j=0; j != n_dofs; j++)
467 Ke(i,j) += JxW[qp]*(dphi[i][qp]*dphi[j][qp]);
468
469
470 // Stop logging the matrix computation
471 perf_log.pop ("Ke");
472
473 // Now we build the element right-hand-side contribution.
474 // This involves a single loop in which we integrate the
475 // "forcing function" in the PDE against the test functions.
476 //
477 // Start logging the right-hand-side computation
478 perf_log.push ("Fe");
479
480 for (unsigned int qp=0; qp<qrule.n_points(); qp++)
481 {
482 // fxy is the forcing function for the Poisson equation.
483 // In this case we set fxy to be a finite difference
484 // Laplacian approximation to the (known) exact solution.
485 //
486 // We will use the second-order accurate FD Laplacian
487 // approximation, which in 2D on a structured grid is
488 //
489 // u_xx + u_yy = (u(i-1,j) + u(i+1,j) +
490 // u(i,j-1) + u(i,j+1) +
491 // -4*u(i,j))/h^2
492 //
493 // Since the value of the forcing function depends only
494 // on the location of the quadrature point (q_point[qp])
495 // we will compute it here, outside of the i-loop
496 const Real x = q_point[qp](0);
497#if LIBMESH_DIM > 1
498 const Real y = q_point[qp](1);
499#else
500 const Real y = 0.;
501#endif
502#if LIBMESH_DIM > 2
503 const Real z = q_point[qp](2);
504#else
505 const Real z = 0.;
506#endif
507 const Real eps = 1.e-3;
508
509 const Real uxx = (exact_solution(x-eps, y, z) +
510 exact_solution(x+eps, y, z) +
511 -2.*exact_solution(x, y, z))/eps/eps;
512
513 const Real uyy = (exact_solution(x, y-eps, z) +
514 exact_solution(x, y+eps, z) +
515 -2.*exact_solution(x, y, z))/eps/eps;
516
517 const Real uzz = (exact_solution(x, y, z-eps) +
518 exact_solution(x, y, z+eps) +
519 -2.*exact_solution(x, y, z))/eps/eps;
520
521 Real fxy;
522 if (dim==1)
523 {
524 // In 1D, compute the rhs by differentiating the
525 // exact solution twice.
526 const Real pi = libMesh::pi;
527 fxy = (0.25*pi*pi)*sin(.5*pi*x);
528 }
529 else
530 {
531 fxy = - (uxx + uyy + ((dim==2) ? 0. : uzz));
532 }
533
534 // Add the RHS contribution
535 for (unsigned int i=0; i != n_dofs; i++)
536 Fe(i) += JxW[qp]*fxy*phi[i][qp];
537 }
538
539 // Stop logging the right-hand-side computation
540 perf_log.pop ("Fe");
541
542 // If this assembly program were to be used on an adaptive mesh,
543 // we would have to apply any hanging node constraint equations
544 // Also, note that here we call heterogenously_constrain_element_matrix_and_vector
545 // to impose a inhomogeneous Dirichlet boundary conditions.
546 dof_map.heterogenously_constrain_element_matrix_and_vector (Ke, Fe, dof_indices);
547
548 // The element matrix and right-hand-side are now built
549 // for this element. Add them to the global matrix and
550 // right-hand-side vector. The SparseMatrix::add_matrix()
551 // and NumericVector::add_vector() members do this for us.
552 // Start logging the insertion of the local (element)
553 // matrix and vector into the global matrix and vector
554 LOG_SCOPE_WITH("matrix insertion", "", perf_log);
555
556 matrix.add_matrix (Ke, dof_indices);
557 system.rhs->add_vector (Fe, dof_indices);
558 }
559
560 // That's it. We don't need to do anything else to the
561 // PerfLog. When it goes out of scope (at this function return)
562 // it will print its log to the screen. Pretty easy, huh?
563}
unsigned int dim
Number(* exact_solution)(const Point &p, const Parameters &, const std::string &, const std::string &)
Defines a dense matrix for use in Finite Element-type computations.
void resize(const unsigned int new_m, const unsigned int new_n)
Resizes the matrix to the specified size and calls zero().
Defines a dense vector for use in Finite Element-type computations.
void resize(const unsigned int n)
Resize the vector.
This class handles the numbering of degrees of freedom on a mesh.
Definition dof_map.h:181
const MeshBase & get_mesh() const
const T_sys & get_system(std::string_view name) const
NumericVector< Number > * rhs
The system matrix.
static std::unique_ptr< FEGenericBase > build(const unsigned int dim, const FEType &type)
Builds a specific finite element type.
class FEType hides (possibly multiple) FEFamily and approximation orders, thereby enabling specialize...
Definition fe_type.h:197
const SparseMatrix< Number > & get_system_matrix() const
Manages consistently variables, degrees of freedom, coefficient vectors, matrices and linear solvers ...
This is the MeshBase class.
Definition mesh_base.h:81
unsigned int mesh_dimension() const
Definition mesh_base.C:430
virtual void add_vector(const T *v, const std::vector< numeric_index_type > &dof_indices)
Computes , where v is a pointer and each dof_indices[i] specifies where to add value v[i].
The PerfLog class allows monitoring of specific events.
Definition perf_log.h:154
This class implements specific orders of Gauss quadrature.
Generic sparse matrix.
virtual void add_matrix(const DenseMatrix< T > &dm, const std::vector< numeric_index_type > &rows, const std::vector< numeric_index_type > &cols)=0
Add the full matrix dm to the SparseMatrix.
const DofMap & get_dof_map() const
Definition system.h:2417
MeshBase & mesh
const Real pi
.
Definition libmesh.h:292
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

References libMesh::SparseMatrix< T >::add_matrix(), libMesh::NumericVector< T >::add_vector(), libMesh::FEGenericBase< OutputType >::build(), dim, exact_solution, libMesh::FIFTH, libMesh::System::get_dof_map(), libMesh::EquationSystems::get_mesh(), libMesh::EquationSystems::get_system(), libMesh::ImplicitSystem::get_system_matrix(), mesh, libMesh::MeshBase::mesh_dimension(), libMesh::QBase::n_points(), libMesh::pi, libMesh::PerfLog::pop(), libMesh::PerfLog::push(), libMesh::Real, libMesh::DenseVector< T >::resize(), libMesh::DenseMatrix< T >::resize(), and libMesh::ExplicitSystem::rhs.

◆ assemble_poisson() [2/2]

void assemble_poisson ( EquationSystems es,
const std::string &  system_name 
)

Definition at line 261 of file miscellaneous_ex16.C.

262{
263 // Get a constant reference to the mesh object.
264 const MeshBase & mesh = es.get_mesh();
265
266 // The dimension that we are running
267 const unsigned int dim = mesh.mesh_dimension();
268
269 // Get a reference to the LinearImplicitSystem we are solving
270 LinearImplicitSystem & system = es.get_system<LinearImplicitSystem>(system_name);
271
272 // Get a pointer to the StaticCondensation class if it exists
273 StaticCondensation * sc = nullptr;
274 if (system.has_static_condensation())
275 sc = &system.get_static_condensation();
276
277 // A reference to the DofMap object for this system. The DofMap
278 // object handles the index translation from node and element numbers
279 // to degree of freedom numbers. We will talk more about the DofMap
280 // in future examples.
281 const DofMap & dof_map = system.get_dof_map();
282
283 // Get a constant reference to the Finite Element type
284 // for the first (and only) variable in the system.
285 FEType fe_type = dof_map.variable_type(0);
286
287 // Build a Finite Element object of the specified type. Since the
288 // FEBase::build() member dynamically creates memory we will
289 // store the object as a std::unique_ptr<FEBase>. This can be thought
290 // of as a pointer that will clean up after itself. Introduction Example 4
291 // describes some advantages of std::unique_ptr's in the context of
292 // quadrature rules.
293 std::unique_ptr<FEBase> fe(FEBase::build(dim, fe_type));
294
295 // A 5th order Gauss quadrature rule for numerical integration.
296 QGauss qrule(dim, FIFTH);
297
298 // Tell the finite element object to use our quadrature rule.
299 fe->attach_quadrature_rule(&qrule);
300
301 // Declare a special finite element object for
302 // boundary integration.
303 std::unique_ptr<FEBase> fe_face(FEBase::build(dim, fe_type));
304
305 // Boundary integration requires one quadrature rule,
306 // with dimensionality one less than the dimensionality
307 // of the element.
308 QGauss qface(dim - 1, FIFTH);
309
310 // Tell the finite element object to use our
311 // quadrature rule.
312 fe_face->attach_quadrature_rule(&qface);
313
314 // Here we define some references to cell-specific data that
315 // will be used to assemble the linear system.
316 //
317 // The element Jacobian * quadrature weight at each integration point.
318 const std::vector<Real> & JxW = fe->get_JxW();
319
320 // The physical XY locations of the quadrature points on the element.
321 // These might be useful for evaluating spatially varying material
322 // properties at the quadrature points.
323 const std::vector<Point> & q_point = fe->get_xyz();
324
325 // The element shape functions evaluated at the quadrature points.
326 const std::vector<std::vector<Real>> & phi = fe->get_phi();
327
328 // The element shape function gradients evaluated at the quadrature
329 // points.
330 const std::vector<std::vector<RealGradient>> & dphi = fe->get_dphi();
331
332 // Define data structures to contain the element matrix
333 // and right-hand-side vector contribution. Following
334 // basic finite element terminology we will denote these
335 // "Ke" and "Fe". These datatypes are templated on
336 // Number, which allows the same code to work for real
337 // or complex numbers.
340
341 // This vector will hold the degree of freedom indices for
342 // the element. These define where in the global system
343 // the element degrees of freedom get mapped.
344 std::vector<dof_id_type> dof_indices;
345
346 // The global system matrix
347 SparseMatrix<Number> & matrix = system.get_system_matrix();
348
349 // Now we will loop over all the elements in the mesh.
350 // We will compute the element matrix and right-hand-side
351 // contribution.
352 //
353 // Element ranges are a nice way to iterate through all the
354 // elements, or all the elements that have some property. The
355 // range will iterate from the first to the last element on
356 // the local processor.
357 // It is smart to make this one const so that we don't accidentally
358 // mess it up! In case users later modify this program to include
359 // refinement, we will be safe and will only consider the active
360 // elements; hence we use a variant of the
361 // active_local_element_ptr_range.
362 for (const auto & elem : mesh.active_local_element_ptr_range())
363 {
364 // Get the degree of freedom indices for the
365 // current element. These define where in the global
366 // matrix and right-hand-side this element will
367 // contribute to.
368 dof_map.dof_indices(elem, dof_indices);
369
370 // Cache the number of degrees of freedom on this element, for
371 // use as a loop bound later. We use cast_int to explicitly
372 // convert from size() (which may be 64-bit) to unsigned int
373 // (which may be 32-bit but which is definitely enough to count
374 // *local* degrees of freedom.
375 const unsigned int n_dofs = cast_int<unsigned int>(dof_indices.size());
376
377 // Compute the element-specific data for the current
378 // element. This involves computing the location of the
379 // quadrature points (q_point) and the shape functions
380 // (phi, dphi) for the current element.
381 fe->reinit(elem);
382
383 // With one variable, we should have the same number of degrees
384 // of freedom as shape functions.
385 libmesh_assert_equal_to(n_dofs, phi.size());
386
387 // Zero the element matrix and right-hand side before
388 // summing them. We use the resize member here because
389 // the number of degrees of freedom might have changed from
390 // the last element. Note that this will be the case if the
391 // element type is different (i.e. the last element was a
392 // triangle, now we are on a quadrilateral).
393
394 // The DenseMatrix::resize() and the DenseVector::resize()
395 // members will automatically zero out the matrix and vector.
396 Ke.resize(n_dofs, n_dofs);
397
398 Fe.resize(n_dofs);
399
400 // Now loop over the quadrature points. This handles
401 // the numeric integration.
402 for (unsigned int qp = 0; qp < qrule.n_points(); qp++)
403 {
404
405 // Now we will build the element matrix. This involves
406 // a double loop to integrate the test functions (i) against
407 // the trial functions (j).
408 for (unsigned int i = 0; i != n_dofs; i++)
409 for (unsigned int j = 0; j != n_dofs; j++)
410 {
411 Ke(i, j) += JxW[qp] * (dphi[i][qp] * dphi[j][qp]);
412 }
413
414 // This is the end of the matrix summation loop
415 // Now we build the element right-hand-side contribution.
416 // This involves a single loop in which we integrate the
417 // "forcing function" in the PDE against the test functions.
418 {
419 const Real x = q_point[qp](0);
420 const Real y = q_point[qp](1);
421 const Real eps = 1.e-3;
422
423 // "fxy" is the forcing function for the Poisson equation.
424 // In this case we set fxy to be a finite difference
425 // Laplacian approximation to the (known) exact solution.
426 //
427 // We will use the second-order accurate FD Laplacian
428 // approximation, which in 2D is
429 //
430 // u_xx + u_yy = (u(i,j-1) + u(i,j+1) +
431 // u(i-1,j) + u(i+1,j) +
432 // -4*u(i,j))/h^2
433 //
434 // Since the value of the forcing function depends only
435 // on the location of the quadrature point (q_point[qp])
436 // we will compute it here, outside of the i-loop
437 const Real fxy =
438 -(exact_solution(x, y - eps) + exact_solution(x, y + eps) + exact_solution(x - eps, y) +
439 exact_solution(x + eps, y) - 4. * exact_solution(x, y)) /
440 eps / eps;
441
442 for (unsigned int i = 0; i != n_dofs; i++)
443 Fe(i) += JxW[qp] * fxy * phi[i][qp];
444 }
445 }
446
447 // We have now reached the end of the RHS summation,
448 // and the end of quadrature point loop, so
449 // the interior element integration has
450 // been completed. However, we have not yet addressed
451 // boundary conditions. For this example we will only
452 // consider simple Dirichlet boundary conditions.
453 //
454 // There are several ways Dirichlet boundary conditions
455 // can be imposed. A simple approach, which works for
456 // interpolary bases like the standard Lagrange polynomials,
457 // is to assign function values to the
458 // degrees of freedom living on the domain boundary. This
459 // works well for interpolary bases, but is more difficult
460 // when non-interpolary (e.g Legendre or Hierarchic) bases
461 // are used.
462 //
463 // Dirichlet boundary conditions can also be imposed with a
464 // "penalty" method. In this case essentially the L2 projection
465 // of the boundary values are added to the matrix. The
466 // projection is multiplied by some large factor so that, in
467 // floating point arithmetic, the existing (smaller) entries
468 // in the matrix and right-hand-side are effectively ignored.
469 //
470 // This amounts to adding a term of the form (in latex notation)
471 //
472 // \frac{1}{\epsilon} \int_{\delta \Omega} \phi_i \phi_j = \frac{1}{\epsilon} \int_{\delta
473 // \Omega} u \phi_i
474 //
475 // where
476 //
477 // \frac{1}{\epsilon} is the penalty parameter, defined such that \epsilon << 1
478 {
479
480 // The following loop is over the sides of the element.
481 // If the element has no neighbor on a side then that
482 // side MUST live on a boundary of the domain.
483 for (auto side : elem->side_index_range())
484 if (elem->neighbor_ptr(side) == nullptr)
485 {
486 // The value of the shape functions at the quadrature
487 // points.
488 const std::vector<std::vector<Real>> & phi_face = fe_face->get_phi();
489
490 // The Jacobian * Quadrature Weight at the quadrature
491 // points on the face.
492 const std::vector<Real> & JxW_face = fe_face->get_JxW();
493
494 // The XYZ locations (in physical space) of the
495 // quadrature points on the face. This is where
496 // we will interpolate the boundary value function.
497 const std::vector<Point> & qface_point = fe_face->get_xyz();
498
499 // Compute the shape function values on the element
500 // face.
501 fe_face->reinit(elem, side);
502
503 // Some shape functions will be 0 on the face, but for
504 // ease of indexing and generality of code we loop over
505 // them anyway
506 libmesh_assert_equal_to(n_dofs, phi_face.size());
507
508 // Loop over the face quadrature points for integration.
509 for (unsigned int qp = 0; qp < qface.n_points(); qp++)
510 {
511 // The location on the boundary of the current
512 // face quadrature point.
513 const Real xf = qface_point[qp](0);
514 const Real yf = qface_point[qp](1);
515
516 // The penalty value. \frac{1}{\epsilon}
517 // in the discussion above.
518 const Real penalty = 1.e10;
519
520 // The boundary value.
521 const Real value = exact_solution(xf, yf);
522
523 // Matrix contribution of the L2 projection.
524 for (unsigned int i = 0; i != n_dofs; i++)
525 for (unsigned int j = 0; j != n_dofs; j++)
526 Ke(i, j) += JxW_face[qp] * penalty * phi_face[i][qp] * phi_face[j][qp];
527
528 // Right-hand-side contribution of the L2
529 // projection.
530 for (unsigned int i = 0; i != n_dofs; i++)
531 Fe(i) += JxW_face[qp] * penalty * value * phi_face[i][qp];
532 }
533 }
534 }
535
536 // We have now finished the quadrature point loop,
537 // and have therefore applied all the boundary conditions.
538
539 // If this assembly program were to be used on an adaptive mesh,
540 // we would have to apply any hanging node constraint equations
541 dof_map.constrain_element_matrix_and_vector(Ke, Fe, dof_indices);
542
543 if (sc)
544 sc->set_current_elem(*elem);
545
546 // The element matrix and right-hand-side are now built
547 // for this element. Add them to the global matrix and
548 // right-hand-side vector. The SparseMatrix::add_matrix()
549 // and NumericVector::add_vector() members do this for us.
550 matrix.add_matrix(Ke, dof_indices);
551 system.rhs->add_vector(Fe, dof_indices);
552 }
553
554 matrix.close();
555}
void dof_indices(const Elem *const elem, std::vector< dof_id_type > &di) const
Definition dof_map.C:2201
const FEType & variable_type(const unsigned int i) const
Definition dof_map.h:2388
void constrain_element_matrix_and_vector(DenseMatrix< Number > &matrix, DenseVector< Number > &rhs, std::vector< dof_id_type > &elem_dofs, bool asymmetric_constraint_rows=true) const
Constrains the element matrix and vector.
Definition dof_map.h:2498
StaticCondensation & get_static_condensation()
virtual void close()=0
Calls the SparseMatrix's internal assembly routines, ensuring that the values are consistent across p...
bool has_static_condensation() const
Definition system.C:2669
static const bool value
Definition xdr_io.C:55

Referenced by main().

◆ exact_solution()

Real exact_solution ( const Real  x,
const Real  y,
const Real  t 
)

This is the exact solution that we are trying to obtain.

We will solve

  • (u_xx + u_yy) = f

and take a finite difference approximation using this function to get f. This is the well-known "method of manufactured solutions".

Definition at line 43 of file exact_solution.C.

46{
47 static const Real pi = acos(-1.);
48
49 return cos(.5*pi*x)*sin(.5*pi*y)*cos(.5*pi*z);
50}

◆ exact_solution_wrapper()

void exact_solution_wrapper ( DenseVector< Number > &  output,
const Point p,
const Real   
)

Definition at line 107 of file introduction_ex4.C.

110{
111 output(0) = exact_solution(p(0),
112 (LIBMESH_DIM>1)?p(1):0,
113 (LIBMESH_DIM>2)?p(2):0);
114}

References exact_solution.

Referenced by main().

◆ main()

int main ( int  argc,
char **  argv 
)

Definition at line 117 of file introduction_ex4.C.

118{
119 // Initialize libMesh and any dependent libraries, like in example 2.
120 LibMeshInit init (argc, argv);
121
122 // This example requires a linear solver package.
123 libmesh_example_requires(libMesh::default_solver_package() != INVALID_SOLVER_PACKAGE,
124 "--enable-petsc, --enable-trilinos, or --enable-eigen");
125
126 // Declare a performance log for the main program
127 // PerfLog perf_main("Main Program");
128
129 // Check for proper calling arguments.
130 libmesh_error_msg_if(argc < 3, "Usage:\n" << "\t " << argv[0] << " -d 2(3)" << " -n 15");
131
132 // Brief message to the user regarding the program name
133 // and command line arguments.
134 libMesh::out << "Running " << argv[0];
135
136 for (int i=1; i<argc; i++)
137 libMesh::out << " " << argv[i];
138
139 libMesh::out << std::endl << std::endl;
140
141 // Read problem dimension from command line. Use int
142 // instead of unsigned since the GetPot overload is ambiguous
143 // otherwise.
144 const int dim = libMesh::command_line_next("-d", 2);
145
146 // Skip higher-dimensional examples on a lower-dimensional libMesh build
147 libmesh_example_requires(dim <= LIBMESH_DIM, "2D/3D support");
148
149 // We use Dirichlet boundary conditions here
150#ifndef LIBMESH_ENABLE_DIRICHLET
151 libmesh_example_requires(false, "--enable-dirichlet");
152#endif
153
154 // Create a mesh with user-defined dimension.
155 // Read number of elements from command line
156 const int ps = libMesh::command_line_next("-n", 15);
157
158 // Read FE order from command line
159 std::string order = "SECOND";
160 order = libMesh::command_line_next("-o", order);
161 order = libMesh::command_line_next("-Order", order);
162
163 // Read FE Family from command line
164 std::string family = "LAGRANGE";
165 family = libMesh::command_line_next("-f", family);
166 family = libMesh::command_line_next("-FEFamily", family);
167
168 // Cannot use discontinuous basis.
169 libmesh_error_msg_if((family == "MONOMIAL") || (family == "XYZ"),
170 "ex4 currently requires a C^0 (or higher) FE basis.");
171
172 // Create a mesh, with dimension to be overridden later, distributed
173 // across the default MPI communicator.
174 Mesh mesh(init.comm());
175
176 // Use the MeshTools::Generation mesh generator to create a uniform
177 // grid on the square [-1,1]^D. We instruct the mesh generator
178 // to build a mesh of 8x8 Quad9 elements in 2D, or Hex27
179 // elements in 3D. Building these higher-order elements allows
180 // us to use higher-order approximation, as in example 3.
181
182 Real halfwidth = dim > 1 ? 1. : 0.;
183 Real halfheight = dim > 2 ? 1. : 0.;
184
185 if ((family == "LAGRANGE") && (order == "FIRST"))
186 {
187 // No reason to use high-order geometric elements if we are
188 // solving with low-order finite elements.
190 ps,
191 (dim>1) ? ps : 0,
192 (dim>2) ? ps : 0,
193 -1., 1.,
194 -halfwidth, halfwidth,
195 -halfheight, halfheight,
196 (dim==1) ? EDGE2 :
197 ((dim == 2) ? QUAD4 : HEX8));
198 }
199
200 else
201 {
203 ps,
204 (dim>1) ? ps : 0,
205 (dim>2) ? ps : 0,
206 -1., 1.,
207 -halfwidth, halfwidth,
208 -halfheight, halfheight,
209 (dim==1) ? EDGE3 :
210 ((dim == 2) ? QUAD9 : HEX27));
211 }
212
213
214 // Print information about the mesh to the screen.
216
217
218 // Create an equation systems object.
219 EquationSystems equation_systems (mesh);
220
221 // Declare the system and its variables.
222 // Create a system named "Poisson"
223 LinearImplicitSystem & system =
224 equation_systems.add_system<LinearImplicitSystem> ("Poisson");
225
226
227 // Add the variable "u" to "Poisson". "u"
228 // will be approximated using second-order approximation by default
229 unsigned int u_var = system.add_variable("u",
230 Utility::string_to_enum<Order> (order),
231 Utility::string_to_enum<FEFamily>(family));
232
233 // Give the system a pointer to the matrix assembly
234 // function.
236
237 // Construct a Dirichlet boundary condition object
238
239 // Indicate which boundary IDs we impose the BC on
240 // We either build a line, a square or a cube, and
241 // here we indicate the boundaries IDs in each case
242 std::set<boundary_id_type> boundary_ids;
243 // the dim==1 mesh has two boundaries with IDs 0 and 1
244 boundary_ids.insert(0);
245 boundary_ids.insert(1);
246 // the dim==2 mesh has four boundaries with IDs 0, 1, 2 and 3
247 if (dim>=2)
248 {
249 boundary_ids.insert(2);
250 boundary_ids.insert(3);
251 }
252 // the dim==3 mesh has four boundaries with IDs 0, 1, 2, 3, 4 and 5
253 if (dim==3)
254 {
255 boundary_ids.insert(4);
256 boundary_ids.insert(5);
257 }
258
259 // Create an AnalyticFunction object that we use to project the BC
260 // This function just calls the function exact_solution via exact_solution_wrapper
261 AnalyticFunction<> exact_solution_object(exact_solution_wrapper);
262
263#ifdef LIBMESH_ENABLE_DIRICHLET
264 // In general, when reusing a system-indexed exact solution, we want
265 // to use the default system-ordering constructor for
266 // DirichletBoundary, so we demonstrate that here. In this case,
267 // though, we have only one variable, so system- and local-
268 // orderings are the same.
269 DirichletBoundary dirichlet_bc
270 (boundary_ids, {u_var}, exact_solution_object);
271
272 // We must add the Dirichlet boundary condition _before_
273 // we call equation_systems.init()
274 system.get_dof_map().add_dirichlet_boundary(dirichlet_bc);
275#endif
276
277 // Initialize the data structures for the equation system.
278 equation_systems.init();
279
280 // Print information about the system to the screen.
281 equation_systems.print_info();
283
284 // Solve the system "Poisson", just like example 2.
285 system.solve();
286
287 // After solving the system write the solution
288 // to a GMV-formatted plot file.
289 if (dim == 1)
290 {
291 GnuPlotIO plot(mesh, "Introduction Example 4, 1D", GnuPlotIO::GRID_ON);
292 plot.write_equation_systems("gnuplot_script", equation_systems);
293 }
294#ifdef LIBMESH_HAVE_EXODUS_API
295 else
296 {
298 "out_3.e" : "out_2.e", equation_systems);
299 }
300#endif // #ifdef LIBMESH_HAVE_EXODUS_API
301
302 // All done.
303 return 0;
304}
Wraps a function pointer into a FunctionBase object.
This class allows one to associate Dirichlet boundary values with a given set of mesh boundary ids an...
void add_dirichlet_boundary(const DirichletBoundary &dirichlet_boundary)
Adds a copy of the specified Dirichlet boundary to the system.
This is the EquationSystems class.
The ExodusII_IO class implements reading meshes in the ExodusII file format from Sandia National Labs...
Definition exodusII_io.h:53
virtual void write_equation_systems(const std::string &fname, const EquationSystems &es, const std::set< std::string > *system_names=nullptr) override
Writes out the solution for no specific time or timestep.
This class implements writing meshes using GNUplot, designed for use only with 1D meshes.
Definition gnuplot_io.h:44
The LibMeshInit class, when constructed, initializes the dependent libraries (e.g.
Definition libmesh.h:92
virtual void solve() override
Assembles & solves the linear system A*x=b.
void print_info(std::ostream &os=libMesh::out, const unsigned int verbosity=0, const bool global=true) const
Prints relevant information about the mesh.
Definition mesh_base.C:1755
The Mesh class is a thin wrapper, around the ReplicatedMesh class by default.
Definition mesh.h:51
void attach_assemble_function(void fptr(EquationSystems &es, const std::string &name))
Register a user function to use in assembling the system matrix and RHS.
Definition system.C:1959
unsigned int add_variable(std::string_view var, const FEType &type, const std::set< subdomain_id_type > *const active_subdomains=nullptr)
Adds the variable var to the list of variables for this system.
Definition system.C:1344
void exact_solution_wrapper(DenseVector< Number > &output, const Point &p, const Real)
void assemble_poisson(EquationSystems &es, const std::string &system_name)
void build_cube(UnstructuredMesh &mesh, const unsigned int nx=0, const unsigned int ny=0, const unsigned int nz=0, const Real xmin=0., const Real xmax=1., const Real ymin=0., const Real ymax=1., const Real zmin=0., const Real zmax=1., const ElemType type=INVALID_ELEM, const bool gauss_lobatto_grid=false)
Builds a (elements) cube.
void init(triangulateio &t)
Initializes the fields of t to nullptr/0 as necessary.
SolverPackage default_solver_package()
Definition libmesh.C:1064
OStreamProxy out
T command_line_next(std::string name, T default_value)
Use GetPot's search()/next() functions to get following arguments from the command line.
Definition libmesh.C:1025

References libMesh::DofMap::add_dirichlet_boundary(), libMesh::EquationSystems::add_system(), libMesh::System::add_variable(), assemble_poisson(), libMesh::System::attach_assemble_function(), libMesh::MeshTools::Generation::build_cube(), libMesh::command_line_next(), libMesh::default_solver_package(), dim, libMesh::EDGE2, libMesh::EDGE3, exact_solution_wrapper(), libMesh::System::get_dof_map(), libMesh::GnuPlotIO::GRID_ON, libMesh::HEX27, libMesh::HEX8, libMesh::EquationSystems::init(), libMesh::INVALID_SOLVER_PACKAGE, main(), mesh, libMesh::out, libMesh::EquationSystems::print_info(), libMesh::MeshBase::print_info(), libMesh::QUAD4, libMesh::QUAD9, libMesh::Real, libMesh::LinearImplicitSystem::solve(), libMesh::MeshOutput< MT >::write_equation_systems(), and libMesh::ExodusII_IO::write_equation_systems().