#include <weighted_flux_qoi.h>

Inheritance diagram for GRINS::WeightedFluxQoI:

Collaboration diagram for GRINS::WeightedFluxQoI:

Public Member Functions
	WeightedFluxQoI (const std::string &qoi_name)

virtual	~WeightedFluxQoI ()

virtual QoIBase *	clone () const
	Clone this QoI. More...

virtual bool	assemble_on_interior () const
	Does the QoI need an element interior assembly loop? More...

virtual bool	assemble_on_sides () const
	Does the QoI need a domain boundary assembly loop? More...

virtual void	init (const GetPot &input, const MultiphysicsSystem &system, unsigned int qoi_num)
	Method to allow QoI to cache any system information needed for QoI calculation, for example, solution variable indices. More...

Public Member Functions inherited from GRINS::QoIBase
	QoIBase (const std::string &qoi_name)

virtual	~QoIBase ()

virtual void	init_context (AssemblyContext &context)

virtual void	element_qoi (AssemblyContext &context, const unsigned int qoi_index)
	Compute the qoi value for element interiors. More...

virtual void	element_qoi_derivative (AssemblyContext &context, const unsigned int qoi_index)
	Compute the qoi derivative with respect to the solution on element interiors. More...

virtual void	side_qoi (AssemblyContext &context, const unsigned int qoi_index)
	Compute the qoi value on the domain boundary. More...

virtual void	side_qoi_derivative (AssemblyContext &context, const unsigned int qoi_index)
	Compute the qoi derivative with respect to the solution on the domain boundary. More...

virtual void	parallel_op (const libMesh::Parallel::Communicator &communicator, libMesh::Number &sys_qoi, libMesh::Number &local_qoi)
	Call the parallel operation for this QoI and cache the value. More...

virtual void	thread_join (libMesh::Number &qoi, const libMesh::Number &other_qoi)
	Call the operation to accumulate this QoI from multiple threads. More...

virtual void	output_qoi (std::ostream &out) const
	Basic output for computed QoI's. More...

libMesh::Number	value () const
	Returns the current QoI value. More...

const std::string &	name () const
	Returns the name of this QoI. More...

Public Member Functions inherited from GRINS::ParameterUser
	ParameterUser (const std::string &user_name)

virtual	~ParameterUser ()

virtual void	set_parameter (libMesh::Number &param_variable, const GetPot &input, const std::string &param_name, libMesh::Number param_default)
	Each subclass can simultaneously read a parameter value from. More...

virtual void	set_parameter (libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &func, const GetPot &input, const std::string &func_param_name, const std::string &param_default)
	Each subclass can simultaneously read a parsed function from. More...

virtual void	set_parameter (libMesh::ParsedFEMFunction< libMesh::Number > &func, const GetPot &input, const std::string &func_param_name, const std::string &param_default)
	Each subclass can simultaneously read a parsed function from. More...

virtual void	move_parameter (const libMesh::Number &old_parameter, libMesh::Number &new_parameter)
	When cloning an object, we need to update parameter pointers. More...

virtual void	move_parameter (const libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &old_func, libMesh::ParsedFunction< libMesh::Number, libMesh::Gradient > &new_func)
	When cloning an object, we need to update parameter pointers. More...

virtual void	move_parameter (const libMesh::ParsedFEMFunction< libMesh::Number > &old_func, libMesh::ParsedFEMFunction< libMesh::Number > &new_func)
	When cloning an object, we need to update parameter pointers. More...

virtual void	register_parameter (const std::string &param_name, libMesh::ParameterMultiAccessor< libMesh::Number > &param_pointer) const
	Each subclass will register its copy of an independent. More...

Private Member Functions
	WeightedFluxQoI ()

Additional Inherited Members
Static Public Attributes inherited from GRINS::ParameterUser
static std::string	zero_vector_function = std::string("{0}")
	A parseable function string with LIBMESH_DIM components, all 0. More...

Protected Attributes inherited from GRINS::QoIBase
std::string	_qoi_name

libMesh::Number	_qoi_value

Detailed Description

Definition at line 44 of file weighted_flux_qoi.h.

Constructor & Destructor Documentation

GRINS::WeightedFluxQoI::WeightedFluxQoI ( const std::string & qoi_name )

Definition at line 44 of file weighted_flux_qoi.C.

     : QoIBase(qoi_name)
   {
     return;
   }

GRINS::WeightedFluxQoI::~WeightedFluxQoI ( )

virtual

Definition at line 50 of file weighted_flux_qoi.C.

   {
     return;
   }

GRINS::WeightedFluxQoI::WeightedFluxQoI ( )

private

Referenced by clone().

Member Function Documentation

bool GRINS::WeightedFluxQoI::assemble_on_interior ( ) const

inlinevirtual

Does the QoI need an element interior assembly loop?

This is pure virtual to force to user to specify.

Implements GRINS::QoIBase.

Definition at line 69 of file weighted_flux_qoi.h.

   {
     // Although we are technically evaluating a lift-function-weighted
     // residual on the interior, our evaluation gets done by the
     // FEMSystem
     return false;
   }

bool GRINS::WeightedFluxQoI::assemble_on_sides ( ) const

inlinevirtual

Does the QoI need a domain boundary assembly loop?

This is pure virtual to force to user to specify.

Implements GRINS::QoIBase.

Definition at line 78 of file weighted_flux_qoi.h.

   {
     // Although our QoI is a boundary integral, it doesn't get
     // evaluated directly as such; FEMSystem uses a superconvergent
     // flux calculation based on the adjoint BC we added.
     return false;
   }

QoIBase * GRINS::WeightedFluxQoI::clone ( ) const

virtual

Clone this QoI.

We return a raw pointer, but it is expected for the user to take ownership and delete the object when done.

Implements GRINS::QoIBase.

Definition at line 55 of file weighted_flux_qoi.C.

References WeightedFluxQoI().

   {
     return new WeightedFluxQoI( *this );
   }

void GRINS::WeightedFluxQoI::init	(	const GetPot &	input,
		const MultiphysicsSystem &	system,
		unsigned int	qoi_num
	)

virtual

Method to allow QoI to cache any system information needed for QoI calculation, for example, solution variable indices.

Reimplemented from GRINS::QoIBase.

Definition at line 61 of file weighted_flux_qoi.C.

   {
     // Read variables for which we want to compute fluxes
     int num_vars = input.vector_variable_size("QoI/WeightedFlux/variables");
 
     if( num_vars <= 0 )
       {
         std::cerr << "Error: Must specify at least one variable to compute"
                   << " weighted fluxes." << std::endl
                   << "Found: " << num_vars << std::endl;
         libmesh_error();
       }
 
     // Read boundary ids on which we want to compute fluxes
     int num_bcs =
       input.vector_variable_size("QoI/WeightedFlux/bc_ids");
 
     if( num_bcs != num_vars )
       {
         std::cerr << "Error: Must specify exactly one boundary id"
                   << " for each specified weighted flux variable."
                   << std::endl
                   << "Found: " << num_bcs << std::endl;
         libmesh_error();
       }
 
     std::vector<libMesh::boundary_id_type> bc_ids;
 
     for( int i = 0; i < num_bcs; i++ )
       bc_ids.push_back( input("QoI/WeightedFlux/bc_ids", -1, i ) );
 
     // Read weight functions with which to compute fluxes
     int num_weights =
       input.vector_variable_size("QoI/WeightedFlux/weights");
 
     if( num_weights != num_vars )
       {
         std::cerr << "Error: Must specify exactly one weight function"
                   << " for each specified weighted flux variable."
                   << std::endl
                   << "Found: " << num_weights << std::endl;
         libmesh_error();
       }
 
     for( int i = 0; i < num_weights; i++ )
       {
         const libMesh::boundary_id_type bc_id =
           input("QoI/WeightedFlux/bc_ids", -1, i );
 
         libmesh_assert_not_equal_to (bc_id, -1);
 
         const std::string var_name =
           ( input("QoI/WeightedFlux/variables", std::string(""), i ) );
 
         libmesh_assert_not_equal_to (var_name, std::string(""));
 
         const std::string func_string =
           input("QoI/WeightedFlux/weights", std::string(""), i);
 
         libmesh_assert_not_equal_to (func_string, std::string(""));
 
         std::set<libMesh::boundary_id_type> bc_id_set;
         bc_id_set.insert(bc_id);
 
         libMesh::ParsedFunction<libMesh::Number> raw_func (func_string);
 
         std::vector<unsigned int> var_indices;
         var_indices.push_back( system.variable_number( var_name ) );
 
         libMesh::CompositeFunction<libMesh::Number>* remapped_func =
           new libMesh::CompositeFunction<libMesh::Number>();
 
         remapped_func->attach_subfunction(raw_func, var_indices);
 
         libMesh::DirichletBoundary adjoint_bc
           (bc_id_set, var_indices, remapped_func);
 
         // FIXME: this is an ugly hack
         MultiphysicsSystem & hacked_system =
           const_cast<MultiphysicsSystem&>(system);
         hacked_system.get_dof_map().add_adjoint_dirichlet_boundary
           (adjoint_bc, qoi_num);
       }
 
     MultiphysicsSystem & hacked_system =
       const_cast<MultiphysicsSystem&>(system);
     hacked_system.reinit_constraints();
   }

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

src/qoi/include/grins/weighted_flux_qoi.h
src/qoi/src/weighted_flux_qoi.C

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation