libMesh
Public Member Functions | Protected Attributes | Private Attributes | List of all members
libMesh::CompositeFunction< Output > Class Template Reference

A function that returns a vector whose components are defined by multiple functions. More...

#include <composite_function.h>

Inheritance diagram for libMesh::CompositeFunction< Output >:
[legend]

Public Member Functions

 CompositeFunction ()=default
 
 CompositeFunction (CompositeFunction &&)=default
 This class can be default move constructed and assigned. More...
 
CompositeFunctionoperator= (CompositeFunction &&)=default
 
 CompositeFunction (const CompositeFunction &)=delete
 This class contains unique_ptr members so it can't be default copied or assigned. More...
 
CompositeFunctionoperator= (const CompositeFunction &)=delete
 
virtual ~CompositeFunction ()=default
 The subfunctions vector is automatically cleaned up. More...
 
void attach_subfunction (const FunctionBase< Output > &f, const std::vector< unsigned int > &index_map)
 Attach a new subfunction, along with a map from the indices of the attached subfunction to the indices of the composed function. More...
 
virtual Output operator() (const Point &p, const Real time=0) override
 
virtual void operator() (const Point &p, const Real time, DenseVector< Output > &output) override
 Evaluation function for time-dependent vector-valued functions. More...
 
virtual Output component (unsigned int i, const Point &p, Real time) override
 
virtual std::unique_ptr< FunctionBase< Output > > clone () const override
 
unsigned int n_subfunctions () const
 
unsigned int n_components () const
 
virtual void init ()
 The actual initialization process. More...
 
virtual void clear ()
 Clears the function. More...
 
void operator() (const Point &p, DenseVector< Output > &output)
 Evaluation function for time-independent vector-valued functions. More...
 
bool initialized () const
 
void set_is_time_dependent (bool is_time_dependent)
 Function to set whether this is a time-dependent function or not. More...
 
bool is_time_dependent () const
 

Protected Attributes

const FunctionBase_master
 Const pointer to our master, initialized to nullptr. More...
 
bool _initialized
 When init() was called so that everything is ready for calls to operator() (...), then this bool is true. More...
 
bool _is_time_dependent
 Cache whether or not this function is actually time-dependent. More...
 

Private Attributes

std::vector< std::unique_ptr< FunctionBase< Output > > > subfunctions
 
std::vector< std::vector< unsigned int > > index_maps
 
std::vector< std::pair< unsigned int, unsigned int > > reverse_index_map
 

Detailed Description

template<typename Output = Number>
class libMesh::CompositeFunction< Output >

A function that returns a vector whose components are defined by multiple functions.

A function which is defined by composing the result of different functions into a single vector. All overridden virtual functions are documented in function_base.h.

Author
Roy Stogner
Date
2012 Function which is a function of another function.

Definition at line 48 of file composite_function.h.

Constructor & Destructor Documentation

◆ CompositeFunction() [1/3]

template<typename Output = Number>
libMesh::CompositeFunction< Output >::CompositeFunction ( )
explicitdefault

◆ CompositeFunction() [2/3]

template<typename Output = Number>
libMesh::CompositeFunction< Output >::CompositeFunction ( CompositeFunction< Output > &&  )
default

This class can be default move constructed and assigned.

◆ CompositeFunction() [3/3]

template<typename Output = Number>
libMesh::CompositeFunction< Output >::CompositeFunction ( const CompositeFunction< Output > &  )
delete

This class contains unique_ptr members so it can't be default copied or assigned.

◆ ~CompositeFunction()

template<typename Output = Number>
virtual libMesh::CompositeFunction< Output >::~CompositeFunction ( )
virtualdefault

The subfunctions vector is automatically cleaned up.

Member Function Documentation

◆ attach_subfunction()

template<typename Output = Number>
void libMesh::CompositeFunction< Output >::attach_subfunction ( const FunctionBase< Output > &  f,
const std::vector< unsigned int > &  index_map 
)

Attach a new subfunction, along with a map from the indices of the attached subfunction to the indices of the composed function.

The composed function will return a vector whose value at index index_map[i] is the value of the attached function at index i, i.e., (*this)(x, t)(index_map[i]) will return f(x, t)(i).

Definition at line 81 of file composite_function.h.

References libMesh::FunctionBase< Output >::_is_time_dependent, libMesh::FunctionBase< Output >::clone(), libMesh::CompositeFunction< Output >::index_maps, libMesh::invalid_uint, libMesh::FunctionBase< Output >::is_time_dependent(), libMesh::CompositeFunction< Output >::reverse_index_map, and libMesh::CompositeFunction< Output >::subfunctions.

Referenced by libMesh::CompositeFunction< Output >::clone().

83  {
84  const unsigned int subfunction_index =
85  cast_int<unsigned int>(subfunctions.size());
86  libmesh_assert_equal_to(subfunctions.size(), index_maps.size());
87 
88  subfunctions.push_back(f.clone());
89  index_maps.push_back(index_map);
90 
91  unsigned int max_index =
92  *std::max_element(index_map.begin(), index_map.end());
93 
94  if (max_index >= reverse_index_map.size())
95  reverse_index_map.resize
96  (max_index+1, std::make_pair(libMesh::invalid_uint,
98 
99  for (std::size_t j=0; j != index_map.size(); ++j)
100  {
101  libmesh_assert_less(index_map[j], reverse_index_map.size());
102  libmesh_assert_equal_to(reverse_index_map[index_map[j]].first,
104  libmesh_assert_equal_to(reverse_index_map[index_map[j]].second,
106  reverse_index_map[index_map[j]] =
107  std::make_pair(subfunction_index, j);
108  }
109 
110  // Now check for time dependence
111  // We only check the function we just added instead of researching all subfunctions
112  // If this is the first subfunction, then that determines the time-dependence.
113  if (subfunctions.size() == 1)
115 
116  // Otherwise, we have more than 1 function already.
117  // If _is_time_dependent is true, then one of the previous
118  // subfunctions is time-dependent and thus this CompositeFunction
119  // time-dependent. If _is_time_dependent is false, then the subfunction
120  // just added determines the time-dependence.
121  else if (!this->_is_time_dependent)
123  }
std::vector< std::unique_ptr< FunctionBase< Output > > > subfunctions
const unsigned int invalid_uint
A number which is used quite often to represent an invalid or uninitialized value.
Definition: libmesh.h:245
bool is_time_dependent() const
bool _is_time_dependent
Cache whether or not this function is actually time-dependent.
std::vector< std::pair< unsigned int, unsigned int > > reverse_index_map
std::vector< std::vector< unsigned int > > index_maps

◆ clear()

template<typename Output = Number>
virtual void libMesh::FunctionBase< Output >::clear ( )
virtualinherited

◆ clone()

template<typename Output = Number>
virtual std::unique_ptr<FunctionBase<Output> > libMesh::CompositeFunction< Output >::clone ( ) const
overridevirtual
Returns
A new copy of the function.

The new copy should be as "deep" as necessary to allow independent destruction and simultaneous evaluations of the copies in different threads.

Implements libMesh::FunctionBase< Output >.

Definition at line 168 of file composite_function.h.

References libMesh::CompositeFunction< Output >::attach_subfunction(), libMesh::CompositeFunction< Output >::CompositeFunction(), libMesh::CompositeFunction< Output >::index_maps, and libMesh::CompositeFunction< Output >::subfunctions.

169  {
170  CompositeFunction * returnval = new CompositeFunction();
171  for (std::size_t i=0; i != subfunctions.size(); ++i)
172  returnval->attach_subfunction(*subfunctions[i], index_maps[i]);
173  return std::unique_ptr<FunctionBase<Output>> (returnval);
174  }
std::vector< std::unique_ptr< FunctionBase< Output > > > subfunctions
std::vector< std::vector< unsigned int > > index_maps

◆ component()

template<typename Output = Number>
virtual Output libMesh::CompositeFunction< Output >::component ( unsigned int  i,
const Point p,
Real  time 
)
overridevirtual
Returns
The vector component i at coordinate p and time time.
Note
Subclasses aren't required to override this, since the default implementation is based on the full vector evaluation, which is often correct.
Subclasses are recommended to override this, since the default implementation is based on a vector evaluation, which is usually unnecessarily inefficient.

Reimplemented from libMesh::FunctionBase< Output >.

Definition at line 152 of file composite_function.h.

References libMesh::invalid_uint, libMesh::CompositeFunction< Output >::reverse_index_map, and libMesh::CompositeFunction< Output >::subfunctions.

Referenced by libMesh::CompositeFunction< Output >::operator()().

155  {
156  if (i >= reverse_index_map.size() ||
158  return 0;
159 
160  libmesh_assert_less(reverse_index_map[i].first,
161  subfunctions.size());
162  libmesh_assert_not_equal_to(reverse_index_map[i].second,
164  return subfunctions[reverse_index_map[i].first]->
165  component(reverse_index_map[i].second,p,time);
166  }
std::vector< std::unique_ptr< FunctionBase< Output > > > subfunctions
const unsigned int invalid_uint
A number which is used quite often to represent an invalid or uninitialized value.
Definition: libmesh.h:245
std::vector< std::pair< unsigned int, unsigned int > > reverse_index_map
virtual Output component(unsigned int i, const Point &p, Real time) override

◆ init()

template<typename Output = Number>
virtual void libMesh::FunctionBase< Output >::init ( )
virtualinherited

◆ initialized()

template<typename Output >
bool libMesh::FunctionBase< Output >::initialized ( ) const
inherited
Returns
true when this object is properly initialized and ready for use, false otherwise.

Definition at line 206 of file function_base.h.

207 {
208  return (this->_initialized);
209 }
bool _initialized
When init() was called so that everything is ready for calls to operator() (...), then this bool is t...

◆ is_time_dependent()

template<typename Output >
bool libMesh::FunctionBase< Output >::is_time_dependent ( ) const
inherited
Returns
true when the function this object represents is actually time-dependent, false otherwise.

Definition at line 220 of file function_base.h.

Referenced by libMesh::CompositeFunction< Output >::attach_subfunction().

221 {
222  return (this->_is_time_dependent);
223 }
bool _is_time_dependent
Cache whether or not this function is actually time-dependent.

◆ n_components()

template<typename Output = Number>
unsigned int libMesh::CompositeFunction< Output >::n_components ( ) const

Definition at line 181 of file composite_function.h.

References libMesh::CompositeFunction< Output >::reverse_index_map.

182  {
183  return reverse_index_map.size();
184  }
std::vector< std::pair< unsigned int, unsigned int > > reverse_index_map

◆ n_subfunctions()

template<typename Output = Number>
unsigned int libMesh::CompositeFunction< Output >::n_subfunctions ( ) const

Definition at line 176 of file composite_function.h.

References libMesh::CompositeFunction< Output >::subfunctions.

177  {
178  return subfunctions.size();
179  }
std::vector< std::unique_ptr< FunctionBase< Output > > > subfunctions

◆ operator()() [1/3]

template<typename Output>
void libMesh::FunctionBase< Output >::operator() ( const Point p,
DenseVector< Output > &  output 
)
inherited

Evaluation function for time-independent vector-valued functions.

Sets output values in the passed-in output DenseVector.

Definition at line 241 of file function_base.h.

243 {
244  // Call the time-dependent function with t=0.
245  this->operator()(p, 0., output);
246 }
virtual Output operator()(const Point &p, const Real time=0.)=0

◆ operator()() [2/3]

template<typename Output = Number>
virtual Output libMesh::CompositeFunction< Output >::operator() ( const Point p,
const Real  time = 0 
)
overridevirtual
Returns
The scalar function value at coordinate p and time time, which defaults to zero.

Pure virtual, so you have to override it.

Implements libMesh::FunctionBase< Output >.

Definition at line 125 of file composite_function.h.

References libMesh::CompositeFunction< Output >::component().

127  {
128  return this->component(0,p,time);
129  }
virtual Output component(unsigned int i, const Point &p, Real time) override

◆ operator()() [3/3]

template<typename Output = Number>
virtual void libMesh::CompositeFunction< Output >::operator() ( const Point p,
const Real  time,
DenseVector< Output > &  output 
)
overridevirtual

Evaluation function for time-dependent vector-valued functions.

Sets output values in the passed-in output DenseVector.

Pure virtual, so you have to override it.

Implements libMesh::FunctionBase< Output >.

Definition at line 131 of file composite_function.h.

References libMesh::CompositeFunction< Output >::index_maps, libMesh::DenseVector< T >::resize(), libMesh::CompositeFunction< Output >::reverse_index_map, libMesh::DenseVector< T >::size(), libMesh::CompositeFunction< Output >::subfunctions, and libMesh::DenseVector< T >::zero().

134  {
135  libmesh_assert_greater_equal (output.size(),
136  reverse_index_map.size());
137 
138  // Necessary in case we have output components not covered by
139  // any subfunctions
140  output.zero();
141 
142  DenseVector<Output> temp;
143  for (std::size_t i=0; i != subfunctions.size(); ++i)
144  {
145  temp.resize(cast_int<unsigned int>(index_maps[i].size()));
146  (*subfunctions[i])(p, time, temp);
147  for (unsigned int j=0; j != temp.size(); ++j)
148  output(index_maps[i][j]) = temp(j);
149  }
150  }
std::vector< std::unique_ptr< FunctionBase< Output > > > subfunctions
virtual unsigned int size() const override
Definition: dense_vector.h:92
std::vector< std::pair< unsigned int, unsigned int > > reverse_index_map
std::vector< std::vector< unsigned int > > index_maps
virtual void zero() override
Set every element in the vector to 0.
Definition: dense_vector.h:379

◆ operator=() [1/2]

template<typename Output = Number>
CompositeFunction& libMesh::CompositeFunction< Output >::operator= ( CompositeFunction< Output > &&  )
default

◆ operator=() [2/2]

template<typename Output = Number>
CompositeFunction& libMesh::CompositeFunction< Output >::operator= ( const CompositeFunction< Output > &  )
delete

◆ set_is_time_dependent()

template<typename Output >
void libMesh::FunctionBase< Output >::set_is_time_dependent ( bool  is_time_dependent)
inherited

Function to set whether this is a time-dependent function or not.

This is intended to be only used by subclasses who cannot natively determine time-dependence. In such a case, this function should be used immediately following construction.

Definition at line 213 of file function_base.h.

214 {
216 }
bool is_time_dependent() const
bool _is_time_dependent
Cache whether or not this function is actually time-dependent.

Member Data Documentation

◆ _initialized

template<typename Output = Number>
bool libMesh::FunctionBase< Output >::_initialized
protectedinherited

When init() was called so that everything is ready for calls to operator() (...), then this bool is true.

Definition at line 180 of file function_base.h.

Referenced by libMesh::AnalyticFunction< Output >::AnalyticFunction(), libMesh::ConstFunction< Output >::ConstFunction(), and libMesh::WrappedFunction< Output >::WrappedFunction().

◆ _is_time_dependent

template<typename Output = Number>
bool libMesh::FunctionBase< Output >::_is_time_dependent
protectedinherited

Cache whether or not this function is actually time-dependent.

Definition at line 185 of file function_base.h.

Referenced by libMesh::CompositeFunction< Output >::attach_subfunction(), and libMesh::ConstFunction< Output >::ConstFunction().

◆ _master

template<typename Output = Number>
const FunctionBase* libMesh::FunctionBase< Output >::_master
protectedinherited

Const pointer to our master, initialized to nullptr.

There may be cases where multiple functions are required, but to save memory, one master handles some centralized data.

Definition at line 174 of file function_base.h.

◆ index_maps

template<typename Output = Number>
std::vector<std::vector<unsigned int> > libMesh::CompositeFunction< Output >::index_maps
private

◆ reverse_index_map

template<typename Output = Number>
std::vector<std::pair<unsigned int, unsigned int> > libMesh::CompositeFunction< Output >::reverse_index_map
private

◆ subfunctions

template<typename Output = Number>
std::vector<std::unique_ptr<FunctionBase<Output> > > libMesh::CompositeFunction< Output >::subfunctions
private

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