FXVolumeUserObject Class Reference

This volumetric FX calculates the value. More...

#include <FXVolumeUserObject.h>

Inheritance diagram for FXVolumeUserObject:

Public Member Functions
	FXVolumeUserObject (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 Point	getCentroid () const
	Get the centroid of the evaluated unit. More...
virtual Real	getVolume () const
	Get the volume of the evaluated unit. More...
virtual Real	computeIntegral () final
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...

Detailed Description

This volumetric FX calculates the value.

Definition at line 24 of file FXVolumeUserObject.h.

Constructor & Destructor Documentation

FXVolumeUserObject()

FXVolumeUserObject::FXVolumeUserObject

(

const InputParameters &

parameters

)

Definition at line 28 of file FXVolumeUserObject.C.

  : FXIntegralBaseUserObject<ElementIntegralVariableUserObject>(parameters)
{
  mooseInfo("Using FXVolumeUserObject '",
            name(),
            "'.\nNote: it is your responsibility to ensure that the dimensionality, order, and "
            "series parameters for FunctionSeries '",
            _function_series.name(),
            "' are sane.");
}

Member Function Documentation

coefficientsChanged()

virtual void MutableCoefficientsInterface::coefficientsChanged ( )

inlineprotectedvirtualinherited

Called when the coefficients have been changed.

Reimplemented in MutableCoefficientsFunctionInterface.

Definition at line 108 of file MutableCoefficientsInterface.h.

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

{};

computeIntegral()

Real FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::computeIntegral ( )

finalprotectedvirtualinherited

Definition at line 136 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.

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

{
  _enforce_size = enforce;
}

finalize()

void FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::finalize ( )

finalvirtualinherited

Definition at line 168 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()

Point FXVolumeUserObject::getCentroid ( ) const

protectedvirtual

Get the centroid of the evaluated unit.

Implements FXIntegralBaseUserObject< ElementIntegralVariableUserObject >.

Definition at line 40 of file FXVolumeUserObject.C.

{
  return _current_elem->centroid();
}

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]

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;
}

getCoefficients() [2/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;
}

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()

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

inherited

Return a reference to the underlying function series.

Definition at line 197 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.

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

{
  return _coefficients.size();
}

getValue()

Real FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::getValue ( )

finalvirtualinherited

Definition at line 204 of file FXIntegralBaseUserObject.h.

{
  return _integral_value;
}

getVolume()

Real FXVolumeUserObject::getVolume ( ) const

protectedvirtual

Get the volume of the evaluated unit.

Implements FXIntegralBaseUserObject< ElementIntegralVariableUserObject >.

Definition at line 46 of file FXVolumeUserObject.C.

{
  return _current_elem_volume;
}

importCoefficients()

void MutableCoefficientsInterface::importCoefficients ( const MutableCoefficientsInterface &  other )

inherited

Import the coefficients from another instance.

Definition at line 117 of file MutableCoefficientsInterface.C.

Referenced by MultiAppFXTransfer::execute().

{
  if (!isCompatibleWith(other))
    mooseError("Cannot import coefficients from incompatible MutableCoefficientsInterface");

  _coefficients = other._coefficients;

  if (_print_coefficients)
    _console << *this;

  coefficientsChanged();
}

initialize()

void FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::initialize ( )

finalvirtualinherited

Definition at line 211 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.

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

{
  // 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;
}

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.

Referenced by FunctionSeries::FunctionSeries().

{
  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();
  }
}

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.

Referenced by FunctionSeries::FunctionSeries().

{
  _characteristics = new_characteristics;
}

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.

Referenced by MutableCoefficientsFunctionInterface::MutableCoefficientsFunctionInterface().

{
  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();
}

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()

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

finalvirtualinherited

Definition at line 237 of file FXIntegralBaseUserObject.h.

{
  _function_series.setLocation(location);

  return _function_series.expand(_coefficients);
}

threadJoin()

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

finalvirtualinherited

Definition at line 224 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;
}

Member Data Documentation

_characteristics

std::vector<std::size_t>& MutableCoefficientsInterface::_characteristics

protectedinherited

An array of integer characteristics that can be used to check compatibility.

Definition at line 108 of file MutableCoefficientsInterface.h.

Referenced by FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject(), MutableCoefficientsInterface::getCharacteristics(), MutableCoefficientsInterface::isCompatibleWith(), and MutableCoefficientsInterface::setCharacteristics().

_coefficient_history

std::vector<std::vector<Real> > FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::_coefficient_history

protectedinherited

History of the expansion coefficients for each solve.

Definition at line 93 of file FXIntegralBaseUserObject.h.

_coefficient_partials

std::vector<Real> FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::_coefficient_partials

protectedinherited

Current coefficient partial sums.

Definition at line 96 of file FXIntegralBaseUserObject.h.

_coefficients

std::vector<Real>& MutableCoefficientsInterface::_coefficients

protectedinherited

The coefficient array.

Definition at line 114 of file MutableCoefficientsInterface.h.

Referenced by FunctionSeries::expand(), FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject(), MutableCoefficientsInterface::getCoefficients(), MutableCoefficientsInterface::getSize(), MutableCoefficientsInterface::importCoefficients(), operator<<(), MutableCoefficientsInterface::operator[](), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

_enforce_size

bool MutableCoefficientsInterface::_enforce_size

protectedinherited

Boolean that locks or allows resizing of the coefficient array.

Definition at line 117 of file MutableCoefficientsInterface.h.

Referenced by MutableCoefficientsInterface::enforceSize(), MutableCoefficientsInterface::isCompatibleWith(), MutableCoefficientsInterface::isSizeEnforced(), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

_function_series

FunctionSeries& FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::_function_series

protectedinherited

Reference to the underlying function series.

Definition at line 99 of file FXIntegralBaseUserObject.h.

Referenced by FXVolumeUserObject().

_keep_history

const bool FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::_keep_history

protectedinherited

Keep the expansion coefficients after each solve.

Definition at line 102 of file FXIntegralBaseUserObject.h.

_print_coefficients

const bool MutableCoefficientsInterface::_print_coefficients

protectedinherited

Boolean to flag if the coefficients should be printed when set.

Definition at line 120 of file MutableCoefficientsInterface.h.

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

_print_state

const bool FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::_print_state

protectedinherited

Flag to prints the state of the zeroth instance in finalize()

Definition at line 105 of file FXIntegralBaseUserObject.h.

_standardized_function_volume

const Real FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::_standardized_function_volume

protectedinherited

Volume of the standardized functional space of integration.

Definition at line 108 of file FXIntegralBaseUserObject.h.

_volume

Real FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::_volume

protectedinherited

Moose volume of evaluation.

Definition at line 111 of file FXIntegralBaseUserObject.h.

---

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

• functional_expansion_tools/include/userobject/FXVolumeUserObject.h
• functional_expansion_tools/src/userobject/FXVolumeUserObject.C