Detailed Description

Definition at line 29 of file integrated_force_output.h.

#include <integrated_force_output.h>

Inheritance diagram for MAST::IntegratedForceOutput:

Collaboration diagram for MAST::IntegratedForceOutput:

[legend]

Public Member Functions
	IntegratedForceOutput (const RealVectorX &nvec)

virtual	~IntegratedForceOutput ()

virtual void	evaluate ()
	this is the abstract interface to be implemented by derived classes. More...

virtual void	evaluate_sensitivity (const MAST::FunctionBase &p)
	this evaluates all relevant sensitivity components on the element. More...

virtual void	evaluate_shape_sensitivity (const MAST::FunctionBase &f)
	this evaluates all relevant shape sensitivity components on the element. More...

virtual void	evaluate_topology_sensitivity (const MAST::FunctionBase &f)
	this evaluates all relevant topological sensitivity components on the element. More...

virtual void	evaluate_topology_sensitivity (const MAST::FunctionBase &f, const MAST::FieldFunction< RealVectorX > &vel)
	this evaluates all relevant topological sensitivity components on the element. More...

virtual void	init (const MAST::GeomElem &elem)
	initialize for the element. More...

virtual void	output_derivative_for_elem (RealVectorX &dq_dX)
	returns the output quantity derivative with respect to state vector in `dq_dX`. More...

virtual Real	output_for_elem ()

virtual Real	output_sensitivity_for_elem (const MAST::FunctionBase &p)

virtual Real	output_sensitivity_total (const MAST::FunctionBase &p)

virtual Real	output_total ()

virtual void	set_elem_data (unsigned int dim, const libMesh::Elem &ref_elem, MAST::GeomElem &elem) const
	virtual function, nothing to be done for fluids More...

virtual void	zero_for_analysis ()
	zeroes the output quantity values stored inside this object so that assembly process can begin. More...

virtual void	zero_for_sensitivity ()
	zeroes the output quantity values stored inside this object so that assembly process can begin. More...

Public Member Functions inherited from MAST::OutputAssemblyElemOperations
	OutputAssemblyElemOperations ()

virtual	~OutputAssemblyElemOperations ()
	virtual destructor More...

const std::set< libMesh::boundary_id_type > &	get_participating_boundaries ()

const std::set< const libMesh::Elem * > &	get_participating_elements () const

const std::set< libMesh::subdomain_id_type > &	get_participating_subdomains ()

virtual bool	if_evaluate_for_boundary (const MAST::GeomElem &elem, const unsigned int s) const
	checks to see if the specified side of the element needs evaluation of the output contribution. More...

virtual bool	if_evaluate_for_element (const MAST::GeomElem &elem) const
	checks to see if the object has been told about the subset of elements and if the specified element is in the subset. More...

void	set_participating_boundaries (const std::set< libMesh::boundary_id_type > &bids)
	The assembly will integration over boudnaries with ids specified in `bids`. More...

void	set_participating_elements (const std::set< const libMesh::Elem *> &elems)
	sets the elements for which this object will evaluate and store the output data. More...

void	set_participating_elements_to_all ()
	This will allow volume contribution from all elements. More...

void	set_participating_subdomains (const std::set< libMesh::subdomain_id_type > &sids)
	The output function can be a boundary integrated quantity, volume integrated quantity or a combination of these two. More...

Public Member Functions inherited from MAST::AssemblyElemOperations
	AssemblyElemOperations ()

virtual	~AssemblyElemOperations ()

virtual void	clear_assembly ()
	clears the assembly object More...

virtual void	clear_discipline_and_system ()
	clears association with a system to this discipline More...

virtual void	clear_elem ()
	clears the element initialization More...

virtual MAST::AssemblyBase &	get_assembly ()

MAST::PhysicsDisciplineBase &	get_discipline ()

virtual std::pair< const MAST::FieldFunction< RealVectorX > *, unsigned int >	get_elem_boundary_velocity_data ()
	searches through the side load data and populates the data with the boundary id and velocity function on the boundary. More...

MAST::ElementBase &	get_physics_elem ()

MAST::SystemInitialization &	get_system_initialization ()

virtual void	set_assembly (MAST::AssemblyBase &assembly)
	sets the assembly object More...

virtual void	set_discipline_and_system (MAST::PhysicsDisciplineBase &discipline, MAST::SystemInitialization &system)
	attaches a system to this discipline More...

virtual void	set_elem_acceleration (const RealVectorX &accel)
	sets the element acceleration More...

virtual void	set_elem_acceleration_sensitivity (const RealVectorX &accel)
	sets the element acceleration More...

virtual void	set_elem_perturbed_acceleration (const RealVectorX &accel)
	sets the element perturbed acceleration More...

virtual void	set_elem_perturbed_solution (const RealVectorX &sol)
	sets the element perturbed solution More...

virtual void	set_elem_perturbed_velocity (const RealVectorX &vel)
	sets the element perturbed velocity More...

virtual void	set_elem_solution (const RealVectorX &sol)
	sets the element solution More...

virtual void	set_elem_solution_sensitivity (const RealVectorX &sol)
	sets the element solution sensitivity More...

virtual void	set_elem_velocity (const RealVectorX &vel)
	sets the element velocity More...

virtual void	set_elem_velocity_sensitivity (const RealVectorX &vel)
	sets the element velocity sensitivity More...

void	set_skip_comm_sum (bool skip)
	If an output has contrinutions only from local processor then the user can request that the global comm().sum() calls be skipped to avoid blocking MPI calls. More...

Protected Attributes
Real	_force
	integrated value of the force More...

Real	_force_sens
	integrated value of the sensitivity of force More...

RealVectorX	_n_vec
	vector along which the force is measured More...

Protected Attributes inherited from MAST::OutputAssemblyElemOperations
std::set< libMesh::boundary_id_type >	_bids
	set of bids for which data will be processed More...

std::set< const libMesh::Elem * >	_elem_subset
	set of elements for which the data will be stored. More...

bool	_if_evaluate_on_all_elems
	if true, evaluates on all elements. More...

std::set< libMesh::subdomain_id_type >	_sub_domain_ids
	set of subdomain ids for which data will be processed. More...

Protected Attributes inherited from MAST::AssemblyElemOperations
MAST::AssemblyBase *	_assembly

MAST::PhysicsDisciplineBase *	_discipline

MAST::ElementBase *	_physics_elem

bool	_skip_comm_sum
	If an output has contrinutions only from local processor then the user can request that the global comm().sum() calls be skipped to avoid blocking MPI calls. More...

MAST::SystemInitialization *	_system

Constructor & Destructor Documentation

◆ IntegratedForceOutput()

MAST::IntegratedForceOutput::IntegratedForceOutput ( const RealVectorX & nvec )

Definition at line 36 of file integrated_force_output.cpp.

◆ ~IntegratedForceOutput()

MAST::IntegratedForceOutput::~IntegratedForceOutput ( )

virtual

Definition at line 47 of file integrated_force_output.cpp.

Member Function Documentation

◆ evaluate()

void MAST::IntegratedForceOutput::evaluate ( )

virtual

this is the abstract interface to be implemented by derived classes.

This method calculates the quantity $ q(X, p) $ . This is provided as an interface since some quantities requires evaluation of all inputs before the final quantity can be calculated. So, the user can call this routine on each element before requesting the output values using either output_for_elem() or output_total().

Implements MAST::OutputAssemblyElemOperations.

Definition at line 113 of file integrated_force_output.cpp.

◆ evaluate_sensitivity()

void MAST::IntegratedForceOutput::evaluate_sensitivity ( const MAST::FunctionBase & p )

virtual

this evaluates all relevant sensitivity components on the element.

This is only done on the current element for which this object has been initialized.

Implements MAST::OutputAssemblyElemOperations.

Definition at line 137 of file integrated_force_output.cpp.

◆ evaluate_shape_sensitivity()

virtual void MAST::IntegratedForceOutput::evaluate_shape_sensitivity ( const MAST::FunctionBase & f )

inlinevirtual

this evaluates all relevant shape sensitivity components on the element.

This is only done on the current element for which this object has been initialized.

Implements MAST::OutputAssemblyElemOperations.

Definition at line 143 of file integrated_force_output.h.

◆ evaluate_topology_sensitivity() [1/2]

virtual void MAST::IntegratedForceOutput::evaluate_topology_sensitivity ( const MAST::FunctionBase & f )

inlinevirtual

this evaluates all relevant topological sensitivity components on the element.

This is only done on the current element for which this object has been initialized.

Implements MAST::OutputAssemblyElemOperations.

Definition at line 154 of file integrated_force_output.h.

◆ evaluate_topology_sensitivity() [2/2]

virtual void MAST::IntegratedForceOutput::evaluate_topology_sensitivity	(	const MAST::FunctionBase &	f,
		const MAST::FieldFunction< RealVectorX > &	vel
	)

inlinevirtual

this evaluates all relevant topological sensitivity components on the element.

This is only done on the current element for which this object has been initialized.

Implements MAST::OutputAssemblyElemOperations.

Definition at line 165 of file integrated_force_output.h.

◆ init()

void MAST::IntegratedForceOutput::init ( const MAST::GeomElem & elem )

virtual

initialize for the element.

Implements MAST::AssemblyElemOperations.

Definition at line 54 of file integrated_force_output.cpp.

◆ output_derivative_for_elem()

void MAST::IntegratedForceOutput::output_derivative_for_elem ( RealVectorX & dq_dX )

virtual

returns the output quantity derivative with respect to state vector in dq_dX.

This method calculates the quantity

$\frac{\partial q(X, p)}{\partial X}$

for this output function. This is returned for the element for which this

Implements MAST::OutputAssemblyElemOperations.

Definition at line 161 of file integrated_force_output.cpp.

◆ output_for_elem()

virtual Real MAST::IntegratedForceOutput::output_for_elem ( )

inlinevirtual

Returns: the output quantity value contribution for the present element for which this object has been initialized. This does not make sense for some output quantities that are defined as averaged over a domain, example the p-norm of the stress (see MAST::StressStrainOutputBase). For such cases, the output_total must be called.

Implements MAST::OutputAssemblyElemOperations.

Definition at line 77 of file integrated_force_output.h.

◆ output_sensitivity_for_elem()

virtual Real MAST::IntegratedForceOutput::output_sensitivity_for_elem ( const MAST::FunctionBase & p )

inlinevirtual

Returns: the output quantity sensitivity for parameter. This method calculates the partial derivative of quantity
$\frac{\partial q(X, p)}{\partial p}$
with respect to parameter . This returns the quantity evaluated for on element for which this object is initialized.

Implements MAST::OutputAssemblyElemOperations.

Definition at line 93 of file integrated_force_output.h.

◆ output_sensitivity_total()

Real MAST::IntegratedForceOutput::output_sensitivity_total ( const MAST::FunctionBase & p )

virtual

Returns: the output quantity sensitivity for parameter. This method calculates the partial derivative of quantity
$\frac{\partial q(X, p)}{\partial p}$
with respect to parameter . This returns the quantity accumulated over all elements.

Implements MAST::OutputAssemblyElemOperations.

Definition at line 100 of file integrated_force_output.cpp.

◆ output_total()

Real MAST::IntegratedForceOutput::output_total ( )

virtual

Returns: the output quantity value accumulated over all elements

Implements MAST::OutputAssemblyElemOperations.

Definition at line 87 of file integrated_force_output.cpp.

◆ set_elem_data()

virtual void MAST::IntegratedForceOutput::set_elem_data	(	unsigned int	dim,
		const libMesh::Elem &	ref_elem,
		MAST::GeomElem &	elem
	)		const

inlinevirtual

virtual function, nothing to be done for fluids

Implements MAST::AssemblyElemOperations.

Definition at line 42 of file integrated_force_output.h.

◆ zero_for_analysis()

void MAST::IntegratedForceOutput::zero_for_analysis ( )

virtual

zeroes the output quantity values stored inside this object so that assembly process can begin.

This will zero out data so that it is ready for a new evaluation. Before sensitivity analysis, call the other method, since some nonlinear functionals need the forward quantities for sensitivity analysis, eg., stress output.

Implements MAST::OutputAssemblyElemOperations.

Definition at line 71 of file integrated_force_output.cpp.

◆ zero_for_sensitivity()

void MAST::IntegratedForceOutput::zero_for_sensitivity ( )

virtual

zeroes the output quantity values stored inside this object so that assembly process can begin.

This will only zero the data to compute new sensitivity analysis.

Implements MAST::OutputAssemblyElemOperations.

Definition at line 79 of file integrated_force_output.cpp.

Member Data Documentation

◆ _force

Real MAST::IntegratedForceOutput::_force

protected

integrated value of the force

Definition at line 181 of file integrated_force_output.h.

◆ _force_sens

Real MAST::IntegratedForceOutput::_force_sens

protected

integrated value of the sensitivity of force

Definition at line 186 of file integrated_force_output.h.

◆ _n_vec

RealVectorX MAST::IntegratedForceOutput::_n_vec

protected

vector along which the force is measured

Definition at line 175 of file integrated_force_output.h.

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

/home/travis/build/MASTmultiphysics/mast-multiphysics/src/fluid/integrated_force_output.h
/home/travis/build/MASTmultiphysics/mast-multiphysics/src/fluid/integrated_force_output.cpp

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ IntegratedForceOutput()

◆ ~IntegratedForceOutput()

Member Function Documentation

◆ evaluate()

◆ evaluate_sensitivity()

◆ evaluate_shape_sensitivity()

◆ evaluate_topology_sensitivity() [1/2]

◆ evaluate_topology_sensitivity() [2/2]

◆ init()

◆ output_derivative_for_elem()

◆ output_for_elem()

◆ output_sensitivity_for_elem()

◆ output_sensitivity_total()

◆ output_total()

◆ set_elem_data()

◆ zero_for_analysis()

◆ zero_for_sensitivity()

Member Data Documentation

◆ _force

◆ _force_sens

◆ _n_vec