LaplaceQoI Class Reference

#include <L-qoi.h>

Inheritance diagram for LaplaceQoI:

Public Member Functions
	LaplaceQoI ()=default
virtual	~LaplaceQoI ()=default
virtual void	init_qoi_count (System &sys)
	Initialize system qoi.
virtual void	init_context (DiffContext &context)
	Prepares the result of a build_context() call for use.
virtual void	postprocess ()
virtual void	element_qoi_derivative (DiffContext &context, const QoISet &qois)
	Does any work that needs to be done on elem in a quantity of interest derivative assembly loop, outputting to elem_qoi_derivative.
virtual void	element_qoi (DiffContext &context, const QoISet &qois)
	Does any work that needs to be done on elem in a quantity of interest assembly loop, outputting to elem_qoi.
virtual std::unique_ptr< DifferentiableQoI >	clone ()
	Copy of this object.
virtual void	clear_qoi ()
	Clear all the data structures associated with the QoI.
virtual void	side_qoi (DiffContext &, const QoISet &)
	Does any work that needs to be done on side of elem in a quantity of interest assembly loop, outputting to elem_qoi.
virtual void	side_qoi_derivative (DiffContext &, const QoISet &)
	Does any work that needs to be done on side of elem in a quantity of interest derivative assembly loop, outputting to elem_qoi_derivative.
virtual void	thread_join (std::vector< Number > &qoi, const std::vector< Number > &other_qoi, const QoISet &qoi_indices)
	Method to combine thread-local qois.
virtual void	parallel_op (const Parallel::Communicator &communicator, std::vector< Number > &sys_qoi, std::vector< Number > &local_qoi, const QoISet &qoi_indices)
	Method to populate system qoi data structure with process-local qoi.
virtual void	finalize_derivative (NumericVector< Number > &derivatives, std::size_t qoi_index)
	Method to finalize qoi derivatives which require more than just a simple sum of element contributions.

Public Attributes
bool	assemble_qoi_sides
	If assemble_qoi_sides is true (it is false by default), the assembly loop for a quantity of interest or its derivatives will loop over domain boundary sides.
bool	assemble_qoi_internal_sides
	If assemble_qoi_internal_sides is true (it is false by default), the assembly loop for a quantity of interest or its derivatives will loop over element sides which do not fall on domain boundaries.
bool	assemble_qoi_elements
	If assemble_qoi_elements is false (it is true by default), the assembly loop for a quantity of interest or its derivatives will skip computing on mesh elements, and will only compute on mesh sides.

Detailed Description

Definition at line 18 of file L-qoi.h.

Constructor & Destructor Documentation

LaplaceQoI()

LaplaceQoI::LaplaceQoI ( )

default

~LaplaceQoI()

virtual LaplaceQoI::~LaplaceQoI ( )

virtualdefault

Member Function Documentation

clear_qoi()

virtual void libMesh::DifferentiableQoI::clear_qoi ( )

inlinevirtualinherited

Clear all the data structures associated with the QoI.

Definition at line 77 of file diff_qoi.h.

{}

Referenced by libMesh::DifferentiableSystem::clear().

clone()

virtual std::unique_ptr< DifferentiableQoI > LaplaceQoI::clone ( )

inlinevirtual

Copy of this object.

User should override to copy any needed state.

Implements libMesh::DifferentiableQoI.

Definition at line 35 of file L-qoi.h.

  {
    return std::make_unique<LaplaceQoI>(*this);
  }

element_qoi()

void LaplaceQoI::element_qoi ( DiffContext &  , const QoISet &    )

virtual

Does any work that needs to be done on elem in a quantity of interest assembly loop, outputting to elem_qoi.

Only qois included in the supplied QoISet need to be assembled.

Reimplemented from libMesh::DifferentiableQoI.

Definition at line 29 of file L-qoi.C.

{
  FEMContext & c = cast_ref<FEMContext &>(context);
 
  FEBase * elem_fe = nullptr;
  c.get_element_fe(0, elem_fe);
 
  // Element Jacobian * quadrature weights for interior integration
  const std::vector<Real> & JxW = elem_fe->get_JxW();
 
  const std::vector<Point> & xyz = elem_fe->get_xyz();
 
  unsigned int n_qpoints = c.get_element_qrule().n_points();
 
  Number dQoI_0 = 0.;
 
  // Loop over quadrature points
  for (unsigned int qp = 0; qp != n_qpoints; qp++)
    {
      // Get co-ordinate locations of the current quadrature point
      const Real xf = xyz[qp](0);
      const Real yf = xyz[qp](1);
 
      // If in the sub-domain omega, add the contribution to the integral R
      if (std::abs(xf - 0.875) <= 0.125 && std::abs(yf - 0.125) <= 0.125)
        {
          // Get the solution value at the quadrature point
          Number T = c.interior_value(0, qp);
 
          // Update the elemental increment dR for each qp
          dQoI_0 += JxW[qp] * T;
        }
    }
 
  // Update the computed value of the global functional R, by adding the contribution from this element
  c.get_qois()[0] = c.get_qois()[0] + dQoI_0;
}

References libMesh::FEMContext::get_element_fe(), libMesh::FEMContext::get_element_qrule(), libMesh::FEAbstract::get_JxW(), libMesh::DiffContext::get_qois(), libMesh::FEAbstract::get_xyz(), libMesh::FEMContext::interior_value(), libMesh::QBase::n_points(), and libMesh::Real.

element_qoi_derivative()

void LaplaceQoI::element_qoi_derivative ( DiffContext &  , const QoISet &    )

virtual

Does any work that needs to be done on elem in a quantity of interest derivative assembly loop, outputting to elem_qoi_derivative.

Only qois included in the supplied QoISet need their derivatives assembled.

Reimplemented from libMesh::DifferentiableQoI.

Definition at line 70 of file L-qoi.C.

{
  FEMContext & c = cast_ref<FEMContext &>(context);
 
  // First we get some references to cell-specific data that
  // will be used to assemble the linear system.
  FEBase * elem_fe = nullptr;
  c.get_element_fe(0, elem_fe);
 
  // Element Jacobian * quadrature weights for interior integration
  const std::vector<Real> & JxW = elem_fe->get_JxW();
 
  // The basis functions for the element
  const std::vector<std::vector<Real>> & phi = elem_fe->get_phi();
 
  // The element quadrature points
  const std::vector<Point > & q_point = elem_fe->get_xyz();
 
  // The number of local degrees of freedom in each variable
  const unsigned int n_T_dofs = c.n_dof_indices(0);
  unsigned int n_qpoints = c.get_element_qrule().n_points();
 
  // Fill the QoI RHS corresponding to this QoI. Since this is the 0th QoI
  // we fill in the [0][i] subderivatives, i corresponding to the variable index.
  // Our system has only one variable, so we only have to fill the [0][0] subderivative
  DenseSubVector<Number> & Q = c.get_qoi_derivatives(0, 0);
 
  // Loop over the qps
  for (unsigned int qp=0; qp != n_qpoints; qp++)
    {
      const Real x = q_point[qp](0);
      const Real y = q_point[qp](1);
 
      // If in the sub-domain over which QoI 0 is supported, add contributions
      // to the adjoint rhs
      if (std::abs(x - 0.875) <= 0.125 && std::abs(y - 0.125) <= 0.125)
        for (unsigned int i=0; i != n_T_dofs; i++)
          Q(i) += JxW[qp]*phi[i][qp];
    } // end of the quadrature point qp-loop
}

References libMesh::FEMContext::get_element_fe(), libMesh::FEMContext::get_element_qrule(), libMesh::FEAbstract::get_JxW(), libMesh::FEGenericBase< OutputType >::get_phi(), libMesh::DiffContext::get_qoi_derivatives(), libMesh::FEAbstract::get_xyz(), libMesh::DiffContext::n_dof_indices(), libMesh::QBase::n_points(), and libMesh::Real.

finalize_derivative()

void libMesh::DifferentiableQoI::finalize_derivative ( NumericVector< Number > &  derivatives, std::size_t  qoi_index  )

virtualinherited

Method to finalize qoi derivatives which require more than just a simple sum of element contributions.

Definition at line 53 of file diff_qoi.C.

{
  // by default, do nothing
}

Referenced by libMesh::FEMSystem::assemble_qoi_derivative().

init_context()

void LaplaceQoI::init_context ( DiffContext &  )

virtual

Prepares the result of a build_context() call for use.

FEMSystem-based problems will need to reimplement this in order to call FE::get_*() as their particular QoI requires. Trying to evaluate a QoI without overriding init_context is both inefficient and deprecated.

Reimplemented from libMesh::DifferentiableQoI.

Definition at line 13 of file L-qoi.C.

{
  FEMContext & c = cast_ref<FEMContext &>(context);
 
  // Now make sure we have requested all the data
  // we need to build the linear system.
  FEBase * elem_fe = nullptr;
  c.get_element_fe(0, elem_fe);
  elem_fe->get_JxW();
  elem_fe->get_phi();
  elem_fe->get_xyz();
}

References libMesh::FEMContext::get_element_fe(), libMesh::FEAbstract::get_JxW(), libMesh::FEGenericBase< OutputType >::get_phi(), and libMesh::FEAbstract::get_xyz().

init_qoi_count()

void LaplaceQoI::init_qoi_count ( System &  )

virtual

Initialize system qoi.

Often this will just call sys.init_qois(some_desired_number_of_qois)

Reimplemented from libMesh::DifferentiableQoI.

Definition at line 7 of file L-qoi.C.

{
  // Only 1 qoi to worry about
  sys.init_qois(1);
}

References libMesh::System::init_qois().

parallel_op()

void libMesh::DifferentiableQoI::parallel_op ( const Parallel::Communicator &  communicator, std::vector< Number > &  sys_qoi, std::vector< Number > &  local_qoi, const QoISet &  qoi_indices  )

virtualinherited

Method to populate system qoi data structure with process-local qoi.

By default, simply sums process qois into system qoi.

Definition at line 41 of file diff_qoi.C.

{
  // Sum everything into local_qoi
  communicator.sum(local_qoi);
 
  // Now put into system qoi
  sys_qoi = local_qoi;
}

Referenced by libMesh::FEMSystem::assemble_qoi().

postprocess()

virtual void LaplaceQoI::postprocess ( )

inlinevirtual

Definition at line 29 of file L-qoi.h.

{}

side_qoi()

virtual void libMesh::DifferentiableQoI::side_qoi ( DiffContext &  , const QoISet &    )

inlinevirtualinherited

Does any work that needs to be done on side of elem in a quantity of interest assembly loop, outputting to elem_qoi.

Only qois included in the supplied QoISet need to be assembled.

Reimplemented in CoupledSystemQoI.

Definition at line 133 of file diff_qoi.h.

  {}

side_qoi_derivative()

virtual void libMesh::DifferentiableQoI::side_qoi_derivative ( DiffContext &  , const QoISet &    )

inlinevirtualinherited

Does any work that needs to be done on side of elem in a quantity of interest derivative assembly loop, outputting to elem_qoi_derivative.

Only qois included in the supplied QoISet need their derivatives assembled.

Reimplemented in LaplaceSystem, CoupledSystemQoI, and LaplaceSystem.

Definition at line 145 of file diff_qoi.h.

  {}

thread_join()

void libMesh::DifferentiableQoI::thread_join ( std::vector< Number > &  qoi, const std::vector< Number > &  other_qoi, const QoISet &  qoi_indices  )

virtualinherited

Method to combine thread-local qois.

By default, simply sums thread qois.

Definition at line 33 of file diff_qoi.C.

{
  for (auto i : index_range(qoi))
    qoi[i] += other_qoi[i];
}

References libMesh::index_range().

Member Data Documentation

assemble_qoi_elements

bool libMesh::DifferentiableQoI::assemble_qoi_elements

inherited

If assemble_qoi_elements is false (it is true by default), the assembly loop for a quantity of interest or its derivatives will skip computing on mesh elements, and will only compute on mesh sides.

Definition at line 101 of file diff_qoi.h.

assemble_qoi_internal_sides

bool libMesh::DifferentiableQoI::assemble_qoi_internal_sides

inherited

If assemble_qoi_internal_sides is true (it is false by default), the assembly loop for a quantity of interest or its derivatives will loop over element sides which do not fall on domain boundaries.

Definition at line 93 of file diff_qoi.h.

assemble_qoi_sides

bool libMesh::DifferentiableQoI::assemble_qoi_sides

inherited

If assemble_qoi_sides is true (it is false by default), the assembly loop for a quantity of interest or its derivatives will loop over domain boundary sides.

To add domain interior sides, also set assemble_qoi_internal_sides to true.

Definition at line 85 of file diff_qoi.h.

Referenced by main().

---

The documentation for this class was generated from the following files:

• examples/adjoints/adjoints_ex2/L-qoi.h
• examples/adjoints/adjoints_ex2/L-qoi.C