WSF
wsf::CN2 Class Reference

An encapsulation of a turbulent CN2 model. More...

#include <WsfAtmosphericTurbulence.hpp>

Inheritance diagram for wsf::CN2:
Collaboration diagram for wsf::CN2:

Public Types

using CN2_Ftn = std::function<double(double)>
Public Types inherited from WsfObject
typedef std::vector< WsfStringIdTypeList
 The list of types returned by GetTypeList.

Public Member Functions

 CN2 (const CN2_Ftn &aCN2_Ftn)
WsfObjectClone () const override
double operator() (double aHeight) const
Public Member Functions inherited from WsfObject
 WsfObject ()
 This is the constructor for the WsfObject class.
 ~WsfObject () override
 This is the destructor for the WsfObject class.
const char * GetScriptClassName () const override
virtual bool ProcessInput (UtInput &aInput)
const std::string & GetType () const
WsfStringId GetTypeId () const
 Get the string ID of the 'type' of the object.
void SetType (WsfStringId aType)
const std::string & GetBaseType () const
WsfStringId GetBaseTypeId () const
const TypeListGetTypeList () const
bool IsA_TypeOf (WsfStringId aType) const
WsfObjectoperator= (const WsfObject &aRhs)
 Assignment operator.
template<typename T>
void Serialize (T &aBuff)
 For XIO (de)serialization.
const std::string & GetName () const
WsfStringId GetNameId () const
void SetName (WsfStringId aName)

Additional Inherited Members

 WsfObject (const WsfObject &aSrc)
 Copy constructor (for Clone()).

Detailed Description

An encapsulation of a turbulent CN2 model.

Member Typedef Documentation

◆ CN2_Ftn

using wsf::CN2::CN2_Ftn = std::function<double(double)>

Constructor & Destructor Documentation

◆ CN2()

wsf::CN2::CN2 ( const CN2_Ftn & aCN2_Ftn)
inline

Referenced by Clone().

Member Function Documentation

◆ Clone()

WsfObject * wsf::CN2::Clone ( ) const
inlineoverridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

References CN2(), and WsfObject::WsfObject().

◆ operator()()

double wsf::CN2::operator() ( double aHeight) const
inline

The documentation for this class was generated from the following file:
Copyrights Multiple, All Rights Reserved