www.mooseframework.org
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | Friends | List of all members
MutableCoefficientsInterface Class Reference

This class is designed to provide a uniform interface for any class that uses an array of coefficients for any of its operations. More...

#include <MutableCoefficientsInterface.h>

Inheritance diagram for MutableCoefficientsInterface:
[legend]

Public Member Functions

 MutableCoefficientsInterface (const MooseObject *moose_object, const InputParameters &parameters)
 
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 void coefficientsChanged ()
 Called when the coefficients have been changed. More...
 

Protected Attributes

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

Friends

std::ostream & operator<< (std::ostream &stream, const MutableCoefficientsInterface &me)
 Friend operator to easily print out the array of coefficients. More...
 

Detailed Description

This class is designed to provide a uniform interface for any class that uses an array of coefficients for any of its operations.

In particular, the MultiAppFXTransfer mechanism transfers coefficients using this interface. Any derived class of MutableCoefficientsInterface can easily be used in any MultiAppFXTransfer-based transfer.

Definition at line 31 of file MutableCoefficientsInterface.h.

Constructor & Destructor Documentation

◆ MutableCoefficientsInterface()

MutableCoefficientsInterface::MutableCoefficientsInterface ( const MooseObject *  moose_object,
const InputParameters &  parameters 
)

Definition at line 30 of file MutableCoefficientsInterface.C.

32  : Restartable(moose_object->getMooseApp(),
33  moose_object->name() + "_coefs",
34  "MutableCoefficientsInterface",
35  moose_object->parameters().get<THREAD_ID>("_tid")),
36  _characteristics(declareRestartableData<std::vector<std::size_t>>("characteristics")),
37  _coefficients(declareRestartableData<std::vector<Real>>("coefficients")),
38  _enforce_size(false),
39  _print_coefficients(parameters.get<bool>("print_when_set")),
40  _console(moose_object->_console)
41 {
42 }
const bool _print_coefficients
Boolean to flag if the coefficients should be printed when set.
bool _enforce_size
Boolean that locks or allows resizing of the coefficient array.
std::vector< Real > & _coefficients
The coefficient array.
std::vector< std::size_t > & _characteristics
An array of integer characteristics that can be used to check compatibility.
const ConsoleStream & _console
MooseObject instance of this to provide access to _console

Member Function Documentation

◆ coefficientsChanged()

virtual void MutableCoefficientsInterface::coefficientsChanged ( )
inlineprotectedvirtual

Called when the coefficients have been changed.

Reimplemented in MutableCoefficientsFunctionInterface.

Definition at line 108 of file MutableCoefficientsInterface.h.

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

108 {};

◆ enforceSize()

void MutableCoefficientsInterface::enforceSize ( bool  enforce)

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

Definition at line 110 of file MutableCoefficientsInterface.C.

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

111 {
112  _enforce_size = enforce;
113 }
bool _enforce_size
Boolean that locks or allows resizing of the coefficient array.

◆ getCharacteristics()

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

Get a reference to the characteristics array.

Definition at line 50 of file MutableCoefficientsInterface.C.

51 {
52  return _characteristics;
53 }
std::vector< std::size_t > & _characteristics
An array of integer characteristics that can be used to check compatibility.

◆ getCoefficients() [1/2]

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

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

Definition at line 56 of file MutableCoefficientsInterface.C.

57 {
58  return _coefficients;
59 }
std::vector< Real > & _coefficients
The coefficient array.

◆ getCoefficients() [2/2]

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

Get a writeable reference to the vector of coefficients.

Definition at line 62 of file MutableCoefficientsInterface.C.

63 {
64  return _coefficients;
65 }
std::vector< Real > & _coefficients
The coefficient array.

◆ getCoefficientsTable()

std::string MutableCoefficientsInterface::getCoefficientsTable ( ) const

Get a formatted string of the coefficients.

Definition at line 68 of file MutableCoefficientsInterface.C.

69 {
70  std::stringbuf string;
71  std::ostream table(&string);
72 
73  table << *this;
74 
75  return string.str();
76 }

◆ getSize()

std::size_t MutableCoefficientsInterface::getSize ( ) const

Get the size, aka number of coefficients.

Definition at line 79 of file MutableCoefficientsInterface.C.

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

80 {
81  return _coefficients.size();
82 }
std::vector< Real > & _coefficients
The coefficient array.

◆ importCoefficients()

void MutableCoefficientsInterface::importCoefficients ( const MutableCoefficientsInterface other)

Import the coefficients from another instance.

Definition at line 116 of file MutableCoefficientsInterface.C.

Referenced by MultiAppFXTransfer::execute().

117 {
118  if (!isCompatibleWith(other))
119  mooseError("Cannot import coefficients from incompatible MutableCoefficientsInterface");
120 
122 
124  _console << *this;
125 
127 }
virtual void coefficientsChanged()
Called when the coefficients have been changed.
const bool _print_coefficients
Boolean to flag if the coefficients should be printed when set.
bool isCompatibleWith(const MutableCoefficientsInterface &other) const
Checks to see if another instance is compatible.
std::vector< Real > & _coefficients
The coefficient array.
const ConsoleStream & _console
MooseObject instance of this to provide access to _console

◆ isCompatibleWith()

bool MutableCoefficientsInterface::isCompatibleWith ( const MutableCoefficientsInterface other) const

Checks to see if another instance is compatible.

Definition at line 85 of file MutableCoefficientsInterface.C.

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

86 {
87  // Check the coefficient sizes if requested
88  if ((_enforce_size && other._enforce_size) && getSize() != other.getSize())
89  return false;
90 
91  // Check the size of the characteristics array
92  if (_characteristics.size() != other._characteristics.size())
93  return false;
94 
95  // Check the values of the characteristics array
96  for (std::size_t i = 0; i < _characteristics.size(); ++i)
97  if (_characteristics[i] != other._characteristics[i])
98  return false;
99 
100  return true;
101 }
bool _enforce_size
Boolean that locks or allows resizing of the coefficient array.
std::vector< std::size_t > & _characteristics
An array of integer characteristics that can be used to check compatibility.
std::size_t getSize() const
Get the size, aka number of coefficients.

◆ isSizeEnforced()

bool MutableCoefficientsInterface::isSizeEnforced ( ) const

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

Definition at line 104 of file MutableCoefficientsInterface.C.

105 {
106  return _enforce_size;
107 }
bool _enforce_size
Boolean that locks or allows resizing of the coefficient array.

◆ operator[]()

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

Get the value of the coefficient at the corresponding index.

Definition at line 44 of file MutableCoefficientsInterface.C.

45 {
46  return _coefficients[index];
47 }
std::vector< Real > & _coefficients
The coefficient array.

◆ resize()

void MutableCoefficientsInterface::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.

Definition at line 130 of file MutableCoefficientsInterface.C.

Referenced by FunctionSeries::FunctionSeries().

131 {
132  if (size != _coefficients.size())
133  {
134  if (_enforce_size &&
135  (size > _coefficients.size() || (size < _coefficients.size() && !fill_out_to_size)))
136  mooseError("Cannot resize coefficient array with size enforcement enabled.");
137 
138  _coefficients.resize(size, fill);
139 
141  _console << *this;
142 
144  }
145 }
virtual void coefficientsChanged()
Called when the coefficients have been changed.
const bool _print_coefficients
Boolean to flag if the coefficients should be printed when set.
bool _enforce_size
Boolean that locks or allows resizing of the coefficient array.
std::vector< Real > & _coefficients
The coefficient array.
const ConsoleStream & _console
MooseObject instance of this to provide access to _console

◆ setCharacteristics()

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

Sets the characteristics array.

Definition at line 148 of file MutableCoefficientsInterface.C.

Referenced by FunctionSeries::FunctionSeries().

150 {
151  _characteristics = new_characteristics;
152 }
std::vector< std::size_t > & _characteristics
An array of integer characteristics that can be used to check compatibility.

◆ setCoefficients() [1/2]

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

Set the coefficients using a copy operation.

Definition at line 155 of file MutableCoefficientsInterface.C.

Referenced by MutableCoefficientsFunctionInterface::MutableCoefficientsFunctionInterface().

156 {
157  if (_enforce_size && new_coefficients.size() != _coefficients.size())
158  mooseError("Cannon assigned a coefficient array with differing size when size enforcement is "
159  "enabled.");
160 
161  _coefficients = new_coefficients;
162 
164  _console << *this;
165 
167 }
virtual void coefficientsChanged()
Called when the coefficients have been changed.
const bool _print_coefficients
Boolean to flag if the coefficients should be printed when set.
bool _enforce_size
Boolean that locks or allows resizing of the coefficient array.
std::vector< Real > & _coefficients
The coefficient array.
const ConsoleStream & _console
MooseObject instance of this to provide access to _console

◆ setCoefficients() [2/2]

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

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

Definition at line 170 of file MutableCoefficientsInterface.C.

171 {
172  if (_enforce_size && dropin_coefficients.size() != _coefficients.size())
173  mooseError("Cannon assigned a coefficient array with differing size when size enforcement is "
174  "enabled.");
175 
176  _coefficients = dropin_coefficients;
177 
179  _console << *this;
180 
182 }
virtual void coefficientsChanged()
Called when the coefficients have been changed.
const bool _print_coefficients
Boolean to flag if the coefficients should be printed when set.
bool _enforce_size
Boolean that locks or allows resizing of the coefficient array.
std::vector< Real > & _coefficients
The coefficient array.
const ConsoleStream & _console
MooseObject instance of this to provide access to _console

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  stream,
const MutableCoefficientsInterface me 
)
friend

Friend operator to easily print out the array of coefficients.

Definition at line 185 of file MutableCoefficientsInterface.C.

186 {
187  const MooseObject * myself_again = dynamic_cast<const MooseObject *>(&me);
188  stream << "\n\n"
189  << "MutableCoefficientsInterface: " << (myself_again ? myself_again->name() : "Unknown")
190  << "\n"
191  << " Number of Coefficients: " << me.getSize() << "\n";
192 
193  for (std::size_t i = 0; i < me.getSize(); ++i)
194  stream << std::setw(4) << i << ": " << std::setw(12) << me[i] << ((i % 6 == 5) ? "\n" : " ");
195 
196  stream << "\n\n";
197 
198  return stream;
199 }
std::size_t getSize() const
Get the size, aka number of coefficients.

Member Data Documentation

◆ _characteristics

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

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(), getCharacteristics(), isCompatibleWith(), and setCharacteristics().

◆ _coefficients

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

◆ _console

const ConsoleStream& MutableCoefficientsInterface::_console
private

MooseObject instance of this to provide access to _console

Definition at line 124 of file MutableCoefficientsInterface.h.

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

◆ _enforce_size

bool MutableCoefficientsInterface::_enforce_size
protected

Boolean that locks or allows resizing of the coefficient array.

Definition at line 117 of file MutableCoefficientsInterface.h.

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

◆ _print_coefficients

const bool MutableCoefficientsInterface::_print_coefficients
protected

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

Definition at line 120 of file MutableCoefficientsInterface.h.

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


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