CoupledSystemQoI Class Reference

#include <H-qoi.h>

Inheritance diagram for CoupledSystemQoI:

Public Member Functions
	CoupledSystemQoI ()=default
	CoupledSystemQoI (const CoupledSystemQoI &)=default
virtual	~CoupledSystemQoI ()=default
virtual void	init_qoi_count (System &sys)
	Initialize system qoi. More...
virtual void	init_context (DiffContext &)
	Prepares the result of a build_context() call for use. More...
virtual void	postprocess ()
virtual void	side_qoi_derivative (DiffContext &context, const QoISet &qois)
	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. More...
virtual void	side_qoi (DiffContext &context, const QoISet &qois)
	Does any work that needs to be done on side of elem in a quantity of interest assembly loop, outputting to elem_qoi. More...
virtual std::unique_ptr< DifferentiableQoI >	clone ()
	Copy of this object. More...
virtual void	init_qoi (std::vector< Number > &)
	Initialize system qoi. More...
void	init_qoi (std::vector< Number > &)
	Non-virtual, to try to help deprecated user code catch this change at compile time (if they specified override) More...
virtual void	clear_qoi ()
	Clear all the data structures associated with the QoI. More...
virtual void	element_qoi (DiffContext &, const QoISet &)
	Does any work that needs to be done on elem in a quantity of interest assembly loop, outputting to elem_qoi. More...
virtual void	element_qoi_derivative (DiffContext &, const QoISet &)
	Does any work that needs to be done on elem in a quantity of interest derivative assembly loop, outputting to elem_qoi_derivative. More...
virtual void	thread_join (std::vector< Number > &qoi, const std::vector< Number > &other_qoi, const QoISet &qoi_indices)
	Method to combine thread-local qois. More...
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. More...
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. More...

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. More...
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. More...
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. More...

Protected Attributes
unsigned int	u_var
unsigned int	p_var

Detailed Description

Definition at line 15 of file H-qoi.h.

Constructor & Destructor Documentation

CoupledSystemQoI() [1/2]

CoupledSystemQoI::CoupledSystemQoI ( )

default

CoupledSystemQoI() [2/2]

CoupledSystemQoI::CoupledSystemQoI ( const CoupledSystemQoI &  )

default

~CoupledSystemQoI()

virtual CoupledSystemQoI::~CoupledSystemQoI ( )

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 91 of file diff_qoi.h.

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

{}

clone()

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

inlinevirtual

Copy of this object.

User should override to copy any needed state.

Implements libMesh::DifferentiableQoI.

Definition at line 33 of file H-qoi.h.

  {
    // Calls defaulted copy constructor for this class
    return std::make_unique<CoupledSystemQoI>(*this);
  }

element_qoi()

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

inlinevirtualinherited

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 in HeatSystem, and LaplaceQoI.

Definition at line 124 of file diff_qoi.h.

  {}

element_qoi_derivative()

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

inlinevirtualinherited

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 in HeatSystem, LaplaceSystem, HeatSystem, LaplaceSystem, and LaplaceQoI.

Definition at line 136 of file diff_qoi.h.

  {}

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.

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

{
  // by default, do nothing
}

init_context()

void CoupledSystemQoI::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 16 of file H-qoi.C.

References libMesh::FEMContext::get_element_fe(), libMesh::FEAbstract::get_JxW(), libMesh::FEAbstract::get_nothing(), libMesh::FEGenericBase< OutputType >::get_phi(), libMesh::FEMContext::get_side_fe(), libMesh::DiffContext::get_system(), libMesh::FEAbstract::get_xyz(), and libMesh::System::variable_number().

{
  FEMContext & c = cast_ref<FEMContext &>(context);

  u_var = c.get_system().variable_number("u");
  p_var = c.get_system().variable_number("p");

  // Note that the concentration and velocity components
  // use the same basis.
  FEBase * u_elem_fe = nullptr;
  c.get_element_fe(u_var, u_elem_fe);
  u_elem_fe->get_nothing();

  FEBase * p_elem_fe = nullptr;
  c.get_element_fe(p_var, p_elem_fe);
  p_elem_fe->get_nothing();

  FEBase * side_fe = nullptr;
  c.get_side_fe(u_var, side_fe);

  side_fe->get_JxW();
  side_fe->get_phi();
  side_fe->get_xyz();

  // Don't waste time on side computations for p
  FEBase * p_side_fe = nullptr;
  c.get_side_fe(p_var, p_side_fe);
  p_side_fe->get_nothing();
}

init_qoi() [1/2]

virtual void libMesh::DifferentiableQoI::init_qoi ( std::vector< Number > &  )

inlinevirtualinherited

Initialize system qoi.

This version of the function required direct vector access, and is now deprecated.

Definition at line 72 of file diff_qoi.h.

{}

init_qoi() [2/2]

void libMesh::DifferentiableQoI::init_qoi ( std::vector< Number > &  )

inlineinherited

Non-virtual, to try to help deprecated user code catch this change at compile time (if they specified override)

Definition at line 78 of file diff_qoi.h.

{}

init_qoi_count()

void CoupledSystemQoI::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 10 of file H-qoi.C.

References libMesh::System::init_qois().

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

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.

References communicator.

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

{
  // Sum everything into local_qoi
  communicator.sum(local_qoi);

  // Now put into system qoi
  sys_qoi = local_qoi;
}

postprocess()

virtual void CoupledSystemQoI::postprocess ( void  )

inlinevirtual

Definition at line 25 of file H-qoi.h.

{}

side_qoi()

void CoupledSystemQoI::side_qoi ( DiffContext &  , const QoISet &    )

virtual

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 from libMesh::DifferentiableQoI.

Definition at line 110 of file H-qoi.C.

References libMesh::DiffContext::get_qois(), libMesh::FEMContext::get_side_fe(), libMesh::FEMContext::get_side_qrule(), libMesh::FEMContext::has_side_boundary_id(), libMesh::QBase::n_points(), libMesh::Real, and libMesh::FEMContext::side_value().

{

  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 * side_fe = nullptr;
  c.get_side_fe(u_var, side_fe);

  // Element Jacobian * quadrature weights for interior integration
  const std::vector<Real> & JxW = side_fe->get_JxW();
  const std::vector<Point> & q_point = side_fe->get_xyz();

  // Loop over qp's, compute the function at each qp and add
  // to get the QoI
  unsigned int n_qpoints = c.get_side_qrule().n_points();

  Number dQoI_0 = 0.;
  Number u = 0.;
  Number C = 0.;

  // If side is on the left outlet
  if (c.has_side_boundary_id(2))
    {
      //Loop over all the qps on this side
      for (unsigned int qp=0; qp != n_qpoints; qp++)
        {
          Real x = q_point[qp](0);

          if (x < 0.)
            {
              // Get u and C at the qp
              u = c.side_value(0, qp);
              C = c.side_value(3, qp);

              dQoI_0 += JxW[qp] * -u * C;
            } // end if
        } // end quadrature loop
    } // end if on bdry

  c.get_qois()[0] += dQoI_0;
}

side_qoi_derivative()

void CoupledSystemQoI::side_qoi_derivative ( DiffContext &  , const QoISet &    )

virtual

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 from libMesh::DifferentiableQoI.

Definition at line 49 of file H-qoi.C.

References libMesh::DiffContext::get_qoi_derivatives(), libMesh::FEMContext::get_side_fe(), libMesh::FEMContext::get_side_qrule(), libMesh::FEMContext::has_side_boundary_id(), libMesh::DiffContext::n_dof_indices(), libMesh::QBase::n_points(), libMesh::Real, and libMesh::FEMContext::side_value().

{
  FEMContext & c = cast_ref<FEMContext &>(context);

  FEBase * side_fe = nullptr;
  c.get_side_fe(u_var, side_fe);

  // Element Jacobian * quadrature weights for interior integration
  const std::vector<Real> & JxW = side_fe->get_JxW();

  // Side basis functions
  const std::vector<std::vector<Real>> & phi = side_fe->get_phi();
  const std::vector<Point > & q_point = side_fe->get_xyz();

  // The number of local degrees of freedom in each variable
  const unsigned int n_u_dofs = c.n_dof_indices(1);

  DenseSubVector<Number> & Qu = c.get_qoi_derivatives(0, 0);
  DenseSubVector<Number> & QC = c.get_qoi_derivatives(0, 3);

  // Now we will build the element Jacobian and residual.
  // Constructing the residual requires the solution and its
  // gradient from the previous timestep.  This must be
  // calculated at each quadrature point by summing the
  // solution degree-of-freedom values by the appropriate
  // weight functions.
  unsigned int n_qpoints = c.get_side_qrule().n_points();

  Number u = 0.;
  Number C = 0.;

  // // If side is on outlet
  if (c.has_side_boundary_id(2))
    {
      // Loop over all the qps on this side
      for (unsigned int qp=0; qp != n_qpoints; qp++)
        {
          Real x = q_point[qp](0);

          // If side is on left outlet
          if (x < 0.)
            {
              // Get u at the qp
              u = c.side_value(0, qp);
              C = c.side_value(3, qp);

              // Add the contribution from each basis function
              for (unsigned int i=0; i != n_u_dofs; i++)
                {
                  Qu(i) += JxW[qp] * -phi[i][qp] * C;
                  QC(i) += JxW[qp] * phi[i][qp] * -u;
                }
            } // end if

        } // end quadrature loop

    } // end if on outlet
}

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.

References libMesh::index_range().

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

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 115 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 107 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 99 of file diff_qoi.h.

Referenced by main().

p_var

unsigned int CoupledSystemQoI::p_var

protected

Definition at line 40 of file H-qoi.h.

u_var

unsigned int CoupledSystemQoI::u_var

protected

Definition at line 40 of file H-qoi.h.

---

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

• examples/adjoints/adjoints_ex3/H-qoi.h
• examples/adjoints/adjoints_ex3/H-qoi.C