This class interacts with a MooseApp through functional expansions. More...

#include <FXIntegralBaseUserObject.h>

Inheritance diagram for FXIntegralBaseUserObject< IntegralBaseVariableUserObject >:

Public Member Functions
	FXIntegralBaseUserObject (const InputParameters &parameters)

const FunctionSeries &	getFunctionSeries () const
	Return a reference to the underlying function series. More...

virtual Real	getValue () final

virtual void	finalize () final

virtual void	initialize () final

virtual Real	spatialValue (const Point &location) const final

virtual void	threadJoin (const UserObject &sibling) final

Real	operator[] (std::size_t index) const
	Get the value of the coefficient at the corresponding index. More...

const std::vector< std::size_t > &	getCharacteristics () const
	Get a reference to the characteristics array. More...

const std::vector< Real > &	getCoefficients () const
	Get a read-only reference to the vector of coefficients. More...

std::vector< Real > &	getCoefficients ()
	Get a writeable reference to the vector of coefficients. More...

std::string	getCoefficientsTable () const
	Get a formatted string of the coefficients. More...

std::size_t	getSize () const
	Get the size, aka number of coefficients. More...

bool	isCompatibleWith (const MutableCoefficientsInterface &other) const
	Checks to see if another instance is compatible. More...

bool	isSizeEnforced () const
	Returns true if the size of the coefficient array is fixed and enforced. More...

void	enforceSize (bool enforce)
	Toggle whether the size of the coefficient array can be changed. More...

void	importCoefficients (const MutableCoefficientsInterface &other)
	Import the coefficients from another instance. More...

void	resize (std::size_t size, Real fill=0.0, bool fill_out_to_size=true)
	Resize the array, using the value for fill if the new size is larger. More...

void	setCharacteristics (const std::vector< std::size_t > &new_characteristics)
	Sets the characteristics array. More...

void	setCoefficients (const std::vector< Real > &new_coefficients)
	Set the coefficients using a copy operation. More...

void	setCoefficients (std::vector< Real > &&dropin_coefficients)
	Set the coefficients using a move operation (only works with temp objects) More...

Protected Member Functions
virtual Real	computeIntegral () final

virtual Point	getCentroid () const =0
	Get the centroid of the evaluated unit. More...

virtual Real	getVolume () const =0
	Get the volume of the evaluated unit. More...

virtual void	coefficientsChanged ()
	Called when the coefficients have been changed. More...

Protected Attributes
std::vector< std::vector< Real > >	_coefficient_history
	History of the expansion coefficients for each solve. More...

std::vector< Real >	_coefficient_partials
	Current coefficient partial sums. More...

FunctionSeries &	_function_series
	Reference to the underlying function series. More...

const bool	_keep_history
	Keep the expansion coefficients after each solve. More...

const bool	_print_state
	Flag to prints the state of the zeroth instance in finalize() More...

const Real	_standardized_function_volume
	Volume of the standardized functional space of integration. More...

Real	_volume
	Moose volume of evaluation. More...

std::vector< std::size_t > &	_characteristics
	An array of integer characteristics that can be used to check compatibility. More...

std::vector< Real > &	_coefficients
	The coefficient array. More...

bool	_enforce_size
	Boolean that locks or allows resizing of the coefficient array. More...

const bool	_print_coefficients
	Boolean to flag if the coefficients should be printed when set. More...

Private Attributes
const ConsoleStream &	_console
	MooseObject instance of `this` to provide access to `_console` More...

Detailed Description

template<class IntegralBaseVariableUserObject>
class FXIntegralBaseUserObject< IntegralBaseVariableUserObject >

This class interacts with a MooseApp through functional expansions.

It is templated to allow the inheritance of two dual classes that operate in a volume (FXVolumeUserObject) or on a boundary (FXBoundaryFluxUserObject and FXBoundaryValueUserObject)

It uses an instance of FunctionSeries to generate the orthonormal function series required to generate the functional expansion coefficients.

Definition at line 43 of file FXIntegralBaseUserObject.h.

Constructor & Destructor Documentation

◆ FXIntegralBaseUserObject()

template<class IntegralBaseVariableUserObject >

FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::FXIntegralBaseUserObject ( const InputParameters & parameters )

Definition at line 114 of file FXIntegralBaseUserObject.h.

   : IntegralBaseVariableUserObject(parameters),
     MutableCoefficientsInterface(this, parameters),
     _function_series(FunctionSeries::checkAndConvertFunction(
         getFunction("function"), UserObject::getParamTempl<std::string>("_moose_base"), name())),
     _keep_history(UserObject::getParamTempl<bool>("keep_history")),
     _print_state(UserObject::getParamTempl<bool>("print_state")),
     _standardized_function_volume(_function_series.getStandardizedFunctionVolume())
 {
   // Size the coefficient arrays
   _coefficient_partials.resize(_function_series.getNumberOfTerms(), 0.0);
   _coefficients.resize(_function_series.getNumberOfTerms(), 0.0);
   _characteristics = _function_series.getOrders();
  
   if (!_keep_history)
     _coefficient_history.resize(0);
 }

Member Function Documentation

◆ coefficientsChanged()

virtual void MutableCoefficientsInterface::coefficientsChanged ( )

inlineprotectedvirtualinherited

Called when the coefficients have been changed.

Reimplemented in MutableCoefficientsFunctionInterface.

Definition at line 107 of file MutableCoefficientsInterface.h.

107 {};

Referenced by MutableCoefficientsInterface::importCoefficients(), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

◆ computeIntegral()

template<class IntegralBaseVariableUserObject >

Real FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::computeIntegral ( )

finalprotectedvirtual

Definition at line 135 of file FXIntegralBaseUserObject.h.

 {
   Real sum = 0.0;
   const Point centroid = getCentroid();
  
   // Check to see if this element/side is within the valid boundaries
   if (!_function_series.isInPhysicalBounds(centroid))
     return 0.0;
  
   // Loop over the quadrature points
   for (_qp = 0; _qp < _q_point.size(); ++_qp)
   {
     // Get the functional terms for a vectorized approach
     _function_series.setLocation(_q_point[_qp]);
     const std::vector<Real> & term_evaluations = _function_series.getGeneration();
  
     // Evaluate the functional expansion coefficients at each quadrature point
     const Real local_contribution = computeQpIntegral();
     const Real common_evaluation = local_contribution * _JxW[_qp] * _coord[_qp];
     for (std::size_t c = 0; c < _coefficient_partials.size(); ++c)
       _coefficient_partials[c] += term_evaluations[c] * common_evaluation;
  
     sum += local_contribution;
   }
  
   _volume += getVolume();
  
   return sum;
 }

◆ enforceSize()

void MutableCoefficientsInterface::enforceSize ( bool enforce )

inherited

Toggle whether the size of the coefficient array can be changed.

Definition at line 111 of file MutableCoefficientsInterface.C.

 {
   _enforce_size = enforce;
 }

Referenced by FunctionSeries::FunctionSeries(), and MutableCoefficientsFunctionInterface::MutableCoefficientsFunctionInterface().

◆ finalize()

template<class IntegralBaseVariableUserObject >

void FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::finalize ( )

finalvirtual

Definition at line 167 of file FXIntegralBaseUserObject.h.

 {
   // Sum the coefficient arrays over all processes
   _communicator.sum(_coefficient_partials);
   _communicator.sum(_volume);
  
   // Normalize the volume of the functional expansion to the FX standard space
   const Real volume_normalization = _standardized_function_volume / _volume;
   for (auto & partial : _coefficient_partials)
     partial *= volume_normalization;
  
   // We now have the completely evaluated coefficients
   _coefficients = _coefficient_partials;
  
   // The average value is the same as the zeroth coefficient
   _integral_value = _coefficient_partials[0];
  
   if (_keep_history)
     _coefficient_history.push_back(_coefficients);
  
   if (_print_state)
   {
     _function_series.setCoefficients(_coefficients);
     _console << COLOR_YELLOW << _function_series << COLOR_DEFAULT << std::endl;
   }
 }

◆ getCentroid()

template<class IntegralBaseVariableUserObject>

virtual Point FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::getCentroid ( ) const

protectedpure virtual

Get the centroid of the evaluated unit.

Implemented in FXBoundaryBaseUserObject, and FXVolumeUserObject.

◆ getCharacteristics()

const std::vector< std::size_t > & MutableCoefficientsInterface::getCharacteristics ( ) const

inherited

Get a reference to the characteristics array.

Definition at line 51 of file MutableCoefficientsInterface.C.

 {
   return _characteristics;
 }

◆ getCoefficients() [1/2]

std::vector< Real > & MutableCoefficientsInterface::getCoefficients ( )

inherited

Get a writeable reference to the vector of coefficients.

Definition at line 63 of file MutableCoefficientsInterface.C.

 {
   return _coefficients;
 }

◆ getCoefficients() [2/2]

const std::vector< Real > & MutableCoefficientsInterface::getCoefficients ( ) const

inherited

Get a read-only reference to the vector of coefficients.

Definition at line 57 of file MutableCoefficientsInterface.C.

 {
   return _coefficients;
 }

◆ getCoefficientsTable()

std::string MutableCoefficientsInterface::getCoefficientsTable ( ) const

inherited

Get a formatted string of the coefficients.

Definition at line 69 of file MutableCoefficientsInterface.C.

 {
   std::stringbuf string;
   std::ostream table(&string);
  
   table << *this;
  
   return string.str();
 }

◆ getFunctionSeries()

template<class IntegralBaseVariableUserObject >

const FunctionSeries & FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::getFunctionSeries ( ) const

Return a reference to the underlying function series.

Definition at line 196 of file FXIntegralBaseUserObject.h.

 {
   return _function_series;
 }

◆ getSize()

std::size_t MutableCoefficientsInterface::getSize ( ) const

inherited

Get the size, aka number of coefficients.

Definition at line 80 of file MutableCoefficientsInterface.C.

 {
   return _coefficients.size();
 }

Referenced by MutableCoefficientsInterface::isCompatibleWith(), and operator<<().

◆ getValue()

template<class IntegralBaseVariableUserObject >

Real FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::getValue ( )

finalvirtual

Definition at line 203 of file FXIntegralBaseUserObject.h.

 {
   return _integral_value;
 }

◆ getVolume()

template<class IntegralBaseVariableUserObject>

virtual Real FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::getVolume ( ) const

protectedpure virtual

Get the volume of the evaluated unit.

Implemented in FXBoundaryBaseUserObject, and FXVolumeUserObject.

◆ importCoefficients()

void MutableCoefficientsInterface::importCoefficients ( const MutableCoefficientsInterface & other )

inherited

Import the coefficients from another instance.

Definition at line 117 of file MutableCoefficientsInterface.C.

 {
   if (!isCompatibleWith(other))
     mooseError("Cannot import coefficients from incompatible MutableCoefficientsInterface");
  
   _coefficients = other._coefficients;
  
   if (_print_coefficients)
     _console << *this;
  
   coefficientsChanged();
 }

Referenced by MultiAppFXTransfer::execute().

◆ initialize()

template<class IntegralBaseVariableUserObject >

void FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::initialize ( )

finalvirtual

Definition at line 210 of file FXIntegralBaseUserObject.h.

 {
   IntegralBaseVariableUserObject::initialize();
  
   // Clear the partial sums
   for (auto & partial : _coefficient_partials)
     partial = 0;
  
   _volume = 0;
 }

◆ isCompatibleWith()

bool MutableCoefficientsInterface::isCompatibleWith ( const MutableCoefficientsInterface & other ) const

inherited

Checks to see if another instance is compatible.

Definition at line 86 of file MutableCoefficientsInterface.C.

 {
   // Check the coefficient sizes if requested
   if ((_enforce_size && other._enforce_size) && getSize() != other.getSize())
     return false;
  
   // Check the size of the characteristics array
   if (_characteristics.size() != other._characteristics.size())
     return false;
  
   // Check the values of the characteristics array
   for (std::size_t i = 0; i < _characteristics.size(); ++i)
     if (_characteristics[i] != other._characteristics[i])
       return false;
  
   return true;
 }

Referenced by MultiAppFXTransfer::execute(), and MutableCoefficientsInterface::importCoefficients().

◆ isSizeEnforced()

bool MutableCoefficientsInterface::isSizeEnforced ( ) const

inherited

Returns true if the size of the coefficient array is fixed and enforced.

Definition at line 105 of file MutableCoefficientsInterface.C.

 {
   return _enforce_size;
 }

◆ operator[]()

Real MutableCoefficientsInterface::operator[] ( std::size_t index ) const

inherited

Get the value of the coefficient at the corresponding index.

Definition at line 45 of file MutableCoefficientsInterface.C.

 {
   return _coefficients[index];
 }

◆ resize()

void MutableCoefficientsInterface::resize	(	std::size_t	size,
		Real	fill = `0.0`,
		bool	fill_out_to_size = `true`
	)

inherited

Resize the array, using the value for fill if the new size is larger.

Definition at line 131 of file MutableCoefficientsInterface.C.

 {
   if (size != _coefficients.size())
   {
     if (_enforce_size &&
         (size > _coefficients.size() || (size < _coefficients.size() && !fill_out_to_size)))
       mooseError("Cannot resize coefficient array with size enforcement enabled.");
  
     _coefficients.resize(size, fill);
  
     if (_print_coefficients)
       _console << *this;
  
     coefficientsChanged();
   }
 }

Referenced by FunctionSeries::FunctionSeries().

◆ setCharacteristics()

void MutableCoefficientsInterface::setCharacteristics ( const std::vector< std::size_t > & new_characteristics )

inherited

Sets the characteristics array.

Definition at line 149 of file MutableCoefficientsInterface.C.

 {
   _characteristics = new_characteristics;
 }

Referenced by FunctionSeries::FunctionSeries().

◆ setCoefficients() [1/2]

void MutableCoefficientsInterface::setCoefficients ( const std::vector< Real > & new_coefficients )

inherited

Set the coefficients using a copy operation.

Definition at line 156 of file MutableCoefficientsInterface.C.

 {
   if (_enforce_size && new_coefficients.size() != _coefficients.size())
     mooseError("Cannon assigned a coefficient array with differing size when size enforcement is "
                "enabled.");
  
   _coefficients = new_coefficients;
  
   if (_print_coefficients)
     _console << *this;
  
   coefficientsChanged();
 }

Referenced by MutableCoefficientsFunctionInterface::MutableCoefficientsFunctionInterface().

◆ setCoefficients() [2/2]

void MutableCoefficientsInterface::setCoefficients ( std::vector< Real > && dropin_coefficients )

inherited

Set the coefficients using a move operation (only works with temp objects)

Definition at line 171 of file MutableCoefficientsInterface.C.

 {
   if (_enforce_size && dropin_coefficients.size() != _coefficients.size())
     mooseError("Cannon assigned a coefficient array with differing size when size enforcement is "
                "enabled.");
  
   _coefficients = dropin_coefficients;
  
   if (_print_coefficients)
     _console << *this;
  
   coefficientsChanged();
 }

◆ spatialValue()

template<class IntegralBaseVariableUserObject >

Real FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::spatialValue ( const Point & location ) const

finalvirtual

Definition at line 236 of file FXIntegralBaseUserObject.h.

 {
   _function_series.setLocation(location);
  
   return _function_series.expand(_coefficients);
 }

◆ threadJoin()

template<class IntegralBaseVariableUserObject >

void FXIntegralBaseUserObject< IntegralBaseVariableUserObject >::threadJoin ( const UserObject & sibling )

finalvirtual

Definition at line 223 of file FXIntegralBaseUserObject.h.

 {
   const FXIntegralBaseUserObject<IntegralBaseVariableUserObject> & sibling =
       static_cast<const FXIntegralBaseUserObject<IntegralBaseVariableUserObject> &>(s);
  
   for (std::size_t c = 0; c < _coefficient_partials.size(); ++c)
     _coefficient_partials[c] += sibling._coefficient_partials[c];
  
   _volume += sibling._volume;
 }