VAPOR3 3.9.4
Public Member Functions | Public Attributes | List of all members
flow::Field Class Referenceabstract

#include <Field.h>

Inheritance diagram for flow::Field:
flow::VaporField

Public Member Functions

 Field ()=default
 
virtual ~Field ()=default
 
virtual bool InsideVolumeVelocity (double time, glm::vec3 pos) const =0
 
virtual bool InsideVolumeScalar (double time, glm::vec3 pos) const =0
 
virtual uint32_t GetNumberOfTimesteps () const =0
 
virtual int GetScalar (double time, glm::vec3 pos, float &val) const =0
 
virtual int GetVelocity (double time, glm::vec3 pos, glm::vec3 &vel) const =0
 
int GetNumOfEmptyVelocityNames () const
 
virtual auto LockParams () -> int=0
 
virtual auto UnlockParams () -> int=0
 

Public Attributes

bool IsSteady = false
 
std::string ScalarName = ""
 
std::array< std::string, 3 > VelocityNames = {{"", "", ""}}
 

Detailed Description

Definition at line 14 of file Field.h.

Constructor & Destructor Documentation

◆ Field()

flow::Field::Field ( )
default

◆ ~Field()

virtual flow::Field::~Field ( )
virtualdefault

Member Function Documentation

◆ GetNumberOfTimesteps()

virtual uint32_t flow::Field::GetNumberOfTimesteps ( ) const
pure virtual

Implemented in flow::VaporField.

◆ GetNumOfEmptyVelocityNames()

int flow::Field::GetNumOfEmptyVelocityNames ( ) const

◆ GetScalar()

virtual int flow::Field::GetScalar ( double  time,
glm::vec3  pos,
float &  val 
) const
pure virtual

Implemented in flow::VaporField.

◆ GetVelocity()

virtual int flow::Field::GetVelocity ( double  time,
glm::vec3  pos,
glm::vec3 &  vel 
) const
pure virtual

Implemented in flow::VaporField.

◆ InsideVolumeScalar()

virtual bool flow::Field::InsideVolumeScalar ( double  time,
glm::vec3  pos 
) const
pure virtual

Implemented in flow::VaporField.

◆ InsideVolumeVelocity()

virtual bool flow::Field::InsideVolumeVelocity ( double  time,
glm::vec3  pos 
) const
pure virtual

Implemented in flow::VaporField.

◆ LockParams()

virtual auto flow::Field::LockParams ( ) -> int
pure virtual

Implemented in flow::VaporField.

◆ UnlockParams()

virtual auto flow::Field::UnlockParams ( ) -> int
pure virtual

Implemented in flow::VaporField.

Member Data Documentation

◆ IsSteady

bool flow::Field::IsSteady = false

Definition at line 58 of file Field.h.

◆ ScalarName

std::string flow::Field::ScalarName = ""

Definition at line 59 of file Field.h.

◆ VelocityNames

std::array<std::string, 3> flow::Field::VelocityNames = {{"", "", ""}}

Definition at line 60 of file Field.h.


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