PeriDyno 1.0.0
Loading...
Searching...
No Matches
dyno::OceanPatch< TDataType > Class Template Reference

#include <OceanPatch.h>

Inheritance diagram for dyno::OceanPatch< TDataType >:
Collaboration diagram for dyno::OceanPatch< TDataType >:

Public Types

typedef TDataType::Real Real
 
typedef TDataType::Coord Coord
 
typedef ::dyno::Complex< RealComplex
 
- Public Types inherited from dyno::Node
template<class T>
using SPtr = std::shared_ptr<T>
 
- Public Types inherited from dyno::OBase
typedef std::vector< FBase * > FieldVector
 
typedef std::map< FieldID, FBase * > FieldMap
 

Public Member Functions

 OceanPatch ()
 
 ~OceanPatch ()
 
std::string getNodeType () override
 
 DEF_VAR (uint, WindType, 2, "wind Types")
 
 DEF_VAR (Real, Amplitude, 0, "")
 
 DEF_VAR (Real, WindSpeed, 0, "")
 
 DEF_VAR (Real, Choppiness, 0, "")
 
 DEF_VAR (Real, GlobalShift, 0, "")
 
 DEF_VAR (Real, WindDirection, Real(60), "Wind direction")
 
 DEF_VAR (uint, Resolution, 512, "")
 
 DEF_VAR (Real, PatchSize, Real(512), "Real patch size")
 
 DEF_VAR (Real, TimeScale, Real(1), "")
 
 DEF_INSTANCE_STATE (HeightField< TDataType >, HeightField, "Height field")
 
- Public Member Functions inherited from dyno::Node
 Node ()
 
 ~Node () override
 
void setName (std::string name)
 
std::string getName () override
 
bool isAutoSync ()
 
bool isAutoHidden ()
 
void setAutoSync (bool con)
 Whether the node can be automatically synchronized when its ancestor is updated.
 
void setAutoHidden (bool con)
 
virtual bool isActive ()
 Check the state of dynamics.
 
virtual void setActive (bool active)
 Set the state of dynamics.
 
virtual bool isVisible ()
 Check the visibility of context.
 
virtual void setVisible (bool visible)
 Set the visibility of context.
 
virtual Real getDt ()
 Simulation timestep.
 
void setDt (Real dt)
 
void setSceneGraph (SceneGraph *scn)
 
SceneGraphgetSceneGraph ()
 
std::vector< NodePort * > & getImportNodes ()
 
std::vector< NodePort * > & getExportNodes ()
 
bool addModule (std::shared_ptr< Module > module)
 Add a module to m_module_list and other special module lists.
 
bool deleteModule (std::shared_ptr< Module > module)
 
template<class TModule>
bool addModule (std::shared_ptr< TModule > tModule)
 Add a speical kind of module.
 
template<class TModule>
bool deleteModule (std::shared_ptr< TModule > tModule)
 
std::list< std::shared_ptr< Module > > & getModuleList ()
 
bool hasModule (std::string name)
 
std::shared_ptr< ModulegetModule (std::string name)
 Get a module by its name.
 
template<class TModule>
std::shared_ptr< TModule > getModule ()
 Get the Module by the module class name.
 
template<class TModule>
std::shared_ptr< TModule > getModule (std::string name)
 
std::shared_ptr< PipelineresetPipeline ()
 
std::shared_ptr< AnimationPipelineanimationPipeline ()
 
std::shared_ptr< GraphicsPipelinegraphicsPipeline ()
 
template<class TModule>
std::shared_ptr< TModule > addModule (std::string name)
 
void update ()
 Called every time interval.
 
void updateGraphicsContext ()
 
void reset ()
 
virtual NBoundingBox boundingBox ()
 
bool connect (NodePort *nPort)
 Depth-first tree traversal.
 
bool disconnect (NodePort *nPort)
 
bool attachField (FBase *field, std::string name, std::string desc, bool autoDestroy=true) override
 Attach a field to Node.
 
std::vector< NodePort * > & getAllNodePorts ()
 
uint sizeOfNodePorts ()
 
uint sizeOfImportNodes () const
 
uint sizeOfExportNodes () const
 
void setForceUpdate (bool b)
 
 DEF_VAR_STATE (Real, ElapsedTime, 0, "Elapsed Time")
 
 DEF_VAR_STATE (Real, TimeStep, Real(0.033), "Time step size")
 
 DEF_VAR_STATE (uint, FrameNumber, 0, "Frame number")
 
- Public Member Functions inherited from dyno::OBase
 OBase ()
 
 ~OBase () override
 
virtual std::string caption ()
 Return the caption.
 
virtual bool captionVisible ()
 Whether to hide the caption in the GUI.
 
virtual std::string description ()
 Return a description for the node or module, override this function to support user-defined description.
 
bool addField (FBase *data)
 Add a field to Base FieldID will be set to the name of Field by default.
 
bool addField (FieldID name, FBase *data)
 Add a field to Base.
 
bool addFieldAlias (FieldID name, FBase *data)
 
bool addFieldAlias (FieldID name, FBase *data, FieldMap &fieldAlias)
 
bool findField (FBase *data)
 Find a field by its pointer.
 
bool findFieldAlias (const FieldID name)
 Find a field by its name.
 
bool findFieldAlias (const FieldID name, FieldMap &fieldAlias)
 Find a field in fieldAlias by its name This function is typically called by other functions.
 
bool removeField (FBase *data)
 Remove a field by its pointer.
 
bool removeFieldAlias (const FieldID name)
 Remove a field by its name.
 
bool removeFieldAlias (const FieldID name, FieldMap &fieldAlias)
 
FBasegetField (const FieldID name)
 Return a field by its name.
 
std::vector< FBase * > & getAllFields ()
 
template<typename T>
TgetField (FieldID name)
 
bool isAllFieldsReady ()
 Check the completeness of all required fields.
 
std::vector< FieldIDgetFieldAlias (FBase *data)
 
int getFieldAliasCount (FBase *data)
 
void setBlockCoord (float x, float y)
 
float bx ()
 
float by ()
 
bool findInputField (FBase *field)
 
bool addInputField (FBase *field)
 
bool removeInputField (FBase *field)
 
std::vector< FBase * > & getInputFields ()
 
bool findOutputField (FBase *field)
 
bool addOutputField (FBase *field)
 
bool addToOutput (FBase *field)
 
bool removeOutputField (FBase *field)
 
bool removeFromOutput (FBase *field)
 
std::vector< FBase * > & getOutputFields ()
 
bool findParameter (FBase *field)
 
bool addParameter (FBase *field)
 
bool removeParameter (FBase *field)
 
std::vector< FBase * > & getParameters ()
 
- Public Member Functions inherited from dyno::Object
 Object ()
 
virtual ~Object ()
 
ObjectId objectId ()
 

Protected Member Functions

void resetStates () override
 
void updateStates () override
 
void postUpdateStates () override
 
- Protected Member Functions inherited from dyno::Node
bool appendExportNode (NodePort *nodePort)
 
bool removeExportNode (NodePort *nodePort)
 
virtual void preUpdateStates ()
 
virtual void updateTopology ()
 
virtual bool validateInputs ()
 
virtual bool requireUpdate ()
 
void tick ()
 notify all state and output fields are updated
 

Private Member Functions

void resetWindType ()
 

Private Attributes

std::vector< WindParammParams
 
DArray2D< ComplexmH0
 
DArray2D< ComplexmHt
 
DArray2D< ComplexmDxt
 
DArray2D< ComplexmDzt
 
DArray2D< CoordmDisp
 
const Real g = 9.81f
 
Real mDirDepend = 0.07f
 
cufftHandle fftPlan
 
int mSpectrumWidth
 
int mSpectrumHeight
 

Additional Inherited Members

- Static Public Member Functions inherited from dyno::Object
static bool registerClass (ClassInfo *ci)
 
static ObjectcreateObject (std::string name)
 
static std::map< std::string, ClassInfo * > * getClassMap ()
 
static ObjectId baseId ()
 Base Id.
 
- Public Attributes inherited from dyno::Node
std::string m_node_name
 
- Protected Attributes inherited from dyno::OBase
std::vector< FBase * > fields_input
 
std::vector< FBase * > fields_output
 
std::vector< FBase * > fields_param
 

Detailed Description

template<typename TDataType>
class dyno::OceanPatch< TDataType >

Definition at line 35 of file OceanPatch.h.

Member Typedef Documentation

◆ Complex

template<typename TDataType>
typedef ::dyno::Complex<Real> dyno::OceanPatch< TDataType >::Complex

Definition at line 41 of file OceanPatch.h.

◆ Coord

template<typename TDataType>
typedef TDataType::Coord dyno::OceanPatch< TDataType >::Coord

Definition at line 40 of file OceanPatch.h.

◆ Real

template<typename TDataType>
typedef TDataType::Real dyno::OceanPatch< TDataType >::Real

Definition at line 39 of file OceanPatch.h.

Constructor & Destructor Documentation

◆ OceanPatch()

template<typename TDataType>
dyno::OceanPatch< TDataType >::OceanPatch ( )

◆ ~OceanPatch()

template<typename TDataType>
dyno::OceanPatch< TDataType >::~OceanPatch ( )

Member Function Documentation

◆ DEF_INSTANCE_STATE()

template<typename TDataType>
dyno::OceanPatch< TDataType >::DEF_INSTANCE_STATE ( HeightField< TDataType > ,
HeightField ,
"Height field"  )

◆ DEF_VAR() [1/9]

template<typename TDataType>
dyno::OceanPatch< TDataType >::DEF_VAR ( Real ,
Amplitude ,
0 ,
""  )

◆ DEF_VAR() [2/9]

template<typename TDataType>
dyno::OceanPatch< TDataType >::DEF_VAR ( Real ,
Choppiness ,
0 ,
""  )

◆ DEF_VAR() [3/9]

template<typename TDataType>
dyno::OceanPatch< TDataType >::DEF_VAR ( Real ,
GlobalShift ,
0 ,
""  )

◆ DEF_VAR() [4/9]

template<typename TDataType>
dyno::OceanPatch< TDataType >::DEF_VAR ( Real ,
PatchSize ,
Real(512) ,
"Real patch size"  )

◆ DEF_VAR() [5/9]

template<typename TDataType>
dyno::OceanPatch< TDataType >::DEF_VAR ( Real ,
TimeScale ,
Real(1) ,
""  )

◆ DEF_VAR() [6/9]

template<typename TDataType>
dyno::OceanPatch< TDataType >::DEF_VAR ( Real ,
WindDirection ,
Real(60) ,
"Wind direction"  )

◆ DEF_VAR() [7/9]

template<typename TDataType>
dyno::OceanPatch< TDataType >::DEF_VAR ( Real ,
WindSpeed ,
0 ,
""  )

◆ DEF_VAR() [8/9]

template<typename TDataType>
dyno::OceanPatch< TDataType >::DEF_VAR ( uint ,
Resolution ,
512 ,
""  )

◆ DEF_VAR() [9/9]

template<typename TDataType>
dyno::OceanPatch< TDataType >::DEF_VAR ( uint ,
WindType ,
2 ,
"wind Types"  )

◆ getNodeType()

template<typename TDataType>
std::string dyno::OceanPatch< TDataType >::getNodeType ( )
inlineoverridevirtual

Reimplemented from dyno::Node.

Definition at line 46 of file OceanPatch.h.

◆ postUpdateStates()

template<typename TDataType>
void dyno::OceanPatch< TDataType >::postUpdateStates ( )
overrideprotectedvirtual

Reimplemented from dyno::Node.

◆ resetStates()

template<typename TDataType>
void dyno::OceanPatch< TDataType >::resetStates ( )
overrideprotectedvirtual

Reimplemented from dyno::Node.

◆ resetWindType()

template<typename TDataType>
void dyno::OceanPatch< TDataType >::resetWindType ( )
private

◆ updateStates()

template<typename TDataType>
void dyno::OceanPatch< TDataType >::updateStates ( )
overrideprotectedvirtual

Reimplemented from dyno::Node.

Member Data Documentation

◆ fftPlan

template<typename TDataType>
cufftHandle dyno::OceanPatch< TDataType >::fftPlan
private

Definition at line 93 of file OceanPatch.h.

◆ g

template<typename TDataType>
const Real dyno::OceanPatch< TDataType >::g = 9.81f
private

Definition at line 89 of file OceanPatch.h.

◆ mDirDepend

template<typename TDataType>
Real dyno::OceanPatch< TDataType >::mDirDepend = 0.07f
private

Definition at line 91 of file OceanPatch.h.

◆ mDisp

template<typename TDataType>
DArray2D<Coord> dyno::OceanPatch< TDataType >::mDisp
private

Definition at line 87 of file OceanPatch.h.

◆ mDxt

template<typename TDataType>
DArray2D<Complex> dyno::OceanPatch< TDataType >::mDxt
private

Definition at line 84 of file OceanPatch.h.

◆ mDzt

template<typename TDataType>
DArray2D<Complex> dyno::OceanPatch< TDataType >::mDzt
private

Definition at line 85 of file OceanPatch.h.

◆ mH0

template<typename TDataType>
DArray2D<Complex> dyno::OceanPatch< TDataType >::mH0
private

Definition at line 81 of file OceanPatch.h.

◆ mHt

template<typename TDataType>
DArray2D<Complex> dyno::OceanPatch< TDataType >::mHt
private

Definition at line 82 of file OceanPatch.h.

◆ mParams

template<typename TDataType>
std::vector<WindParam> dyno::OceanPatch< TDataType >::mParams
private

Definition at line 79 of file OceanPatch.h.

◆ mSpectrumHeight

template<typename TDataType>
int dyno::OceanPatch< TDataType >::mSpectrumHeight
private

Definition at line 96 of file OceanPatch.h.

◆ mSpectrumWidth

template<typename TDataType>
int dyno::OceanPatch< TDataType >::mSpectrumWidth
private

Definition at line 95 of file OceanPatch.h.


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