ChangedSignFunction< dim, number > Class Template Reference

Developer Documentation: MeltPoolDG::Functions::ChangedSignFunction< dim, number > Class Template Reference
Developer Documentation
MeltPoolDG::Functions::ChangedSignFunction< dim, number > Class Template Reference

Wrapper function that flips the sign of another function. More...

#include <functions.hpp>

Inheritance diagram for MeltPoolDG::Functions::ChangedSignFunction< dim, number >:
[legend]
Collaboration diagram for MeltPoolDG::Functions::ChangedSignFunction< dim, number >:
[legend]

Public Member Functions

 ChangedSignFunction (const std::shared_ptr< dealii::Function< dim, number > > fu_)
 
number value (const dealii::Point< dim > &point, const unsigned int component) const override
 
dealii::Tensor< 1, dim, number > gradient (const dealii::Point< dim > &point, const unsigned int component) const override
 
dealii::SymmetricTensor< 2, dim, number > hessian (const dealii::Point< dim > &point, const unsigned int component) const override
 
void set_time (const number new_time) override
 
void advance_time (const number delta_t) override
 

Private Attributes

const std::shared_ptr< dealii::Function< dim, number > > fu
 

Detailed Description

template<int dim, typename number>
class MeltPoolDG::Functions::ChangedSignFunction< dim, number >

Wrapper function that flips the sign of another function.

This class takes a shared pointer to a dealii::Function and returns the negative of its value, gradient, and hessian. Time-related operations are forwarded to the underlying function.

Constructor & Destructor Documentation

◆ ChangedSignFunction()

template<int dim, typename number >
MeltPoolDG::Functions::ChangedSignFunction< dim, number >::ChangedSignFunction ( const std::shared_ptr< dealii::Function< dim, number > >  fu_)
inline

Member Function Documentation

◆ advance_time()

template<int dim, typename number >
void MeltPoolDG::Functions::ChangedSignFunction< dim, number >::advance_time ( const number  delta_t)
inlineoverride

◆ gradient()

template<int dim, typename number >
dealii::Tensor< 1, dim, number > MeltPoolDG::Functions::ChangedSignFunction< dim, number >::gradient ( const dealii::Point< dim > &  point,
const unsigned int  component 
) const
inlineoverride

◆ hessian()

template<int dim, typename number >
dealii::SymmetricTensor< 2, dim, number > MeltPoolDG::Functions::ChangedSignFunction< dim, number >::hessian ( const dealii::Point< dim > &  point,
const unsigned int  component 
) const
inlineoverride

◆ set_time()

template<int dim, typename number >
void MeltPoolDG::Functions::ChangedSignFunction< dim, number >::set_time ( const number  new_time)
inlineoverride

◆ value()

template<int dim, typename number >
number MeltPoolDG::Functions::ChangedSignFunction< dim, number >::value ( const dealii::Point< dim > &  point,
const unsigned int  component 
) const
inlineoverride

Member Data Documentation

◆ fu

template<int dim, typename number >
const std::shared_ptr<dealii::Function<dim, number> > MeltPoolDG::Functions::ChangedSignFunction< dim, number >::fu
private

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