OpenWalnut  1.5.0dev
Public Member Functions | Protected Member Functions | List of all members
WAD Class Reference

Computes the AD (Axional Diffusivity) of a given Tensor. More...

#include <WAD.h>

+ Inheritance diagram for WAD:
+ Collaboration diagram for WAD:

Public Member Functions

 WAD ()
 Creates an object to perform the computation. More...
 
- Public Member Functions inherited from WObjectNDIP< WDataSetDTIToScalar_I >
virtual ~WObjectNDIP ()
 Destructor. More...
 
virtual std::string getName () const
 The name of the object. More...
 
virtual std::string getDescription () const
 The description of this object. More...
 
virtual const char ** getIcon () const
 The icon of this object. More...
 
virtual WProperties::SPtr getProperties ()
 Return the property group of this object. More...
 
- Public Member Functions inherited from WDataSetDTIToScalar_I
virtual WDataSetScalar::SPtr operator() (WProgress::SPtr progress, WBoolFlag const &shutdown, WDataSetDTI::SPtr tensors, WDataSetVector::SPtr evals)
 This runs the given strategy on the given dataset. More...
 
virtual ~WDataSetDTIToScalar_I ()
 Destructor. More...
 

Protected Member Functions

virtual double tensorToScalar (const WVector3d &evals, const WTensorSym< 2, 3, float > &tensor)
 Actual AD computation takes place inhere. More...
 
- Protected Member Functions inherited from WObjectNDIP< WDataSetDTIToScalar_I >
 WObjectNDIP (std::string name, std::string description, const char **icon=NULL)
 Construct a NDIP'ed object. More...
 

Additional Inherited Members

- Public Types inherited from WObjectNDIP< WDataSetDTIToScalar_I >
typedef std::shared_ptr< WObjectNDIPSPtr
 Shared ptr to an instance. More...
 
typedef std::shared_ptr< const WObjectNDIPConstSPtr
 Shared ptr to a const instance. More...
 
- Protected Attributes inherited from WObjectNDIP< WDataSetDTIToScalar_I >
WProperties::SPtr m_properties
 the properties of the object. More...
 

Detailed Description

Computes the AD (Axional Diffusivity) of a given Tensor.

\[ AD = \lambda_1 \]

Definition at line 40 of file WAD.h.

Constructor & Destructor Documentation

◆ WAD()

WAD::WAD ( )

Creates an object to perform the computation.

Definition at line 27 of file WAD.cpp.

Member Function Documentation

◆ tensorToScalar()

double WAD::tensorToScalar ( const WVector3d evals,
const WTensorSym< 2, 3, float > &  tensor 
)
protectedvirtual

Actual AD computation takes place inhere.

Parameters
evalsWith the three given Eigenvalues, we may compute the AD. See the wikipedia article above for the formula.
tensorAlthough not needed for AD computation, the API requires us to use the signature.
Returns
The AD of the tensor.

Implements WDataSetDTIToScalar_I.

Definition at line 32 of file WAD.cpp.


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