SpECTRE  v2024.06.05
domain::FunctionsOfTime::SettleToConstantQuaternion Class Reference

Given an initial function of time that is a unit quaternion, transitions to a constant-in-time unit quaternion. More...

#include <SettleToConstantQuaternion.hpp>

Public Member Functions

 SettleToConstantQuaternion (const std::array< DataVector, 3 > &initial_func_and_derivs, double match_time, double decay_time)
 
 SettleToConstantQuaternion (SettleToConstantQuaternion &&)=default
 
SettleToConstantQuaternionoperator= (SettleToConstantQuaternion &&)=default
 
 SettleToConstantQuaternion (const SettleToConstantQuaternion &)=default
 
SettleToConstantQuaternionoperator= (const SettleToConstantQuaternion &)=default
 
 WRAPPED_PUPable_decl_template (SettleToConstantQuaternion)
 
 SettleToConstantQuaternion (CkMigrateMessage *)
 
auto get_clone () const -> std::unique_ptr< FunctionOfTime > override
 
std::array< DataVector, 1 > func (const double t) const override
 Returns the function at an arbitrary time t. More...
 
std::array< DataVector, 2 > func_and_deriv (const double t) const override
 Returns the function and its first derivative at an arbitrary time t. More...
 
std::array< DataVector, 3 > func_and_2_derivs (const double t) const override
 Returns the function and the first two derivatives at an arbitrary time t. More...
 
std::array< double, 2 > time_bounds () const override
 Returns the domain of validity of the function. More...
 
double expiration_after (const double) const override
 The first expiration time after time. More...
 
void pup (PUP::er &p) override
 
- Public Member Functions inherited from domain::FunctionsOfTime::FunctionOfTime
 FunctionOfTime (FunctionOfTime &&)=default
 
FunctionOfTimeoperator= (FunctionOfTime &&)=default
 
 FunctionOfTime (const FunctionOfTime &)=default
 
FunctionOfTimeoperator= (const FunctionOfTime &)=default
 
virtual auto get_clone () const -> std::unique_ptr< FunctionOfTime >=0
 
virtual std::array< double, 2 > time_bounds () const =0
 Returns the domain of validity of the function. For FunctionsOfTime that allow a small amount of time extrapolation, time_bounds tells you the bounds including the allowed extrapolation interval. More...
 
virtual double expiration_after (double time) const =0
 The first expiration time after time. More...
 
virtual void update (double, DataVector, double)
 Updates the maximum derivative of the FunctionOfTime at a given time while also resetting the expiration. By default, a FunctionOfTime cannot be updated. More...
 
virtual std::array< DataVector, 1 > func (double t) const =0
 The DataVector can be of any size. More...
 
virtual std::array< DataVector, 2 > func_and_deriv (double t) const =0
 The DataVector can be of any size. More...
 
virtual std::array< DataVector, 3 > func_and_2_derivs (double t) const =0
 The DataVector can be of any size. More...
 
 WRAPPED_PUPable_abstract (FunctionOfTime)
 

Friends

bool operator== (const SettleToConstantQuaternion &lhs, const SettleToConstantQuaternion &rhs)
 

Detailed Description

Given an initial function of time that is a unit quaternion, transitions to a constant-in-time unit quaternion.

Given an initial unit quaternion \(\mathbf{f}(t)\) and its first two derivatives at the matching time \(t_0\), return a function of time \(\mathbf{g}(t)\) satisfies \(\mathbf{g}(t=t_0)=\mathbf{f}f(t=t_0)\) and approaches a constant value for \(t > t_0\) on a timescale of \(\tau\). This is done by internally holding a SettleToConstant function of time initialized from \(\mathbf{f}(t)\) and its first two derivatives at the matching time, but then ensuring that \(\mathbf{g}(t)\) remains a unit quaternion.

Member Function Documentation

◆ expiration_after()

double domain::FunctionsOfTime::SettleToConstantQuaternion::expiration_after ( const double  time) const
inlineoverridevirtual

The first expiration time after time.

Details

For non-updatable functions, this returns infinity. For updatable functions, the first expiration time after time is found by determining the update immediately before time. The expiration time of this update is what is returned. If time happens to be an update itself, then the expiration of that update is returned.

Implements domain::FunctionsOfTime::FunctionOfTime.

◆ func()

std::array< DataVector, 1 > domain::FunctionsOfTime::SettleToConstantQuaternion::func ( const double  t) const
inlineoverridevirtual

Returns the function at an arbitrary time t.

Implements domain::FunctionsOfTime::FunctionOfTime.

◆ func_and_2_derivs()

std::array< DataVector, 3 > domain::FunctionsOfTime::SettleToConstantQuaternion::func_and_2_derivs ( const double  t) const
inlineoverridevirtual

Returns the function and the first two derivatives at an arbitrary time t.

Implements domain::FunctionsOfTime::FunctionOfTime.

◆ func_and_deriv()

std::array< DataVector, 2 > domain::FunctionsOfTime::SettleToConstantQuaternion::func_and_deriv ( const double  t) const
inlineoverridevirtual

Returns the function and its first derivative at an arbitrary time t.

Implements domain::FunctionsOfTime::FunctionOfTime.

◆ get_clone()

auto domain::FunctionsOfTime::SettleToConstantQuaternion::get_clone ( ) const -> std::unique_ptr< FunctionOfTime >
overridevirtual

◆ time_bounds()

std::array< double, 2 > domain::FunctionsOfTime::SettleToConstantQuaternion::time_bounds ( ) const
inlineoverridevirtual

Returns the domain of validity of the function.

Implements domain::FunctionsOfTime::FunctionOfTime.


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