SOFA plugin: SofaEulerianFluid  master
Open source framework for multi-physics simuation
sofaeulerianfluid::Fluid2D Class Reference

#include <Fluid2D.h>

Inheritance diagram for sofaeulerianfluid::Fluid2D:

Classes

struct  CubeData
 For each cube, store the vertex indices on each 3 first edges, and the data value. More...
 
struct  Face
 
struct  Vertex
 

Public Attributes

sofa::core::objectmodel::Data< int > f_nx
 grid size along x axis More...
 
sofa::core::objectmodel::Data< int > f_ny
 grid size along y axis More...
 
sofa::core::objectmodel::Data< realf_cellwidth
 width of each cell More...
 
sofa::core::objectmodel::Data< realf_height
 initial fluid height More...
 
sofa::core::objectmodel::Data< vec2f_dir
 initial fluid surface normal More...
 
sofa::core::objectmodel::Data< realf_tstart
 starting time for fluid source More...
 
sofa::core::objectmodel::Data< realf_tstop
 stopping time for fluid source More...
 
- Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< bool > f_listening
 
- Public Attributes inherited from sofa::core::objectmodel::Base
std::vector< lifecycle::DeprecatedData * > m_oldAttributes
 
Data< int > d_messageLogCount
 
Data< std::string > name
 
Data< bool > f_printLog
 
Data< sofa::core::objectmodel::TagSetf_tags
 
Data< sofa::type::BoundingBoxf_bbox
 
Data< sofa::core::objectmodel::ComponentStated_componentState
 
std::string m_definitionSourceFileName
 
int m_definitionSourceFilePos
 
std::string m_instanciationSourceFileName
 
int m_instanciationSourceFilePos
 

Protected Attributes

Grid2Dfluid
 
Grid2Dfnext
 
Grid2Dftemp
 
sofa::type::vector< Vertexpoints
 
sofa::type::vector< Facefacets
 
sofa::type::vector< CubeDataplanes
 
- Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINK > l_context
 
LinkSlaves l_slaves
 
SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINK > l_master
 
- Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallbackm_internalEngine
 
VecData m_vecData
 
MapData m_aliasData
 
VecLink m_vecLink
 
MapLink m_aliasLink
 

Public Member Functions

 SOFA_CLASS (Fluid2D, sofa::core::BehaviorModel)
 
int getNx () const
 
void setNx (int v)
 
int getNy () const
 
void setNy (int v)
 
void init () override
 
void reset () override
 
void updatePosition (SReal dt) override
 
void draw (const sofa::core::visual::VisualParams *vparams) override
 
void computeBBox (const sofa::core::ExecParams *, bool onlyVisible=false) override
 
virtual void updateVisual ()
 
- Public Member Functions inherited from sofa::core::BehaviorModel
 SOFA_ABSTRACT_CLASS (BehaviorModel, objectmodel::BaseObject)
 
virtual bool addBBox (SReal *, SReal *)
 
bool insertInNode (objectmodel::BaseNode *node) override
 
bool removeInNode (objectmodel::BaseNode *node) override
 
- Public Member Functions inherited from sofa::core::objectmodel::BaseObject
 SOFA_CLASS (BaseObject, Base)
 
void setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
 
void setSrc (const std::string &v, const BaseObject *loader, std::vector< std::string > *attributeList=nullptr)
 
BasefindLinkDestClass (const BaseClass *destType, const std::string &path, const BaseLink *link) override
 
virtual std::string getPathName () const override
 
SReal getTime () const
 
const BaseContextgetContext () const
 
BaseContextgetContext ()
 
const BaseObjectgetMaster () const
 
BaseObjectgetMaster ()
 
const VecSlavesgetSlaves () const
 
BaseObjectgetSlave (const std::string &name) const
 
virtual void addSlave (BaseObject::SPtr s)
 
virtual void removeSlave (BaseObject::SPtr s)
 
virtual void handleEvent (Event *)
 
virtual void handleTopologyChange ()
 
virtual void handleTopologyChange (core::topology::Topology *t)
 
void parse (BaseObjectDescription *arg) override
 
virtual void bwdInit ()
 
virtual void reinit ()
 
void updateInternal ()
 
virtual void storeResetState ()
 
virtual void cleanup ()
 
SReal getTime () const
 
- Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClassgetClass () const
 
void addDeprecatedAttribute (lifecycle::DeprecatedData *attribute)
 
void addUpdateCallback (const std::string &name, std::initializer_list< BaseData * > inputs, std::function< sofa::core::objectmodel::ComponentState(const DataTracker &)> function, std::initializer_list< BaseData * > outputs)
 
void addOutputsToCallback (const std::string &name, std::initializer_list< BaseData * > outputs)
 
const std::string & getName () const
 
void setName (const std::string &n)
 
void setName (const std::string &n, int counter)
 
std::string getTypeName () const
 
virtual std::string getClassName () const
 
virtual std::string getTemplateName () const final
 
std::string getNameSpaceName () const
 
void setDefinitionSourceFileName (const std::string &sourceFileName)
 
const std::string & getDefinitionSourceFileName () const
 
void setDefinitionSourceFilePos (const int)
 
int getDefinitionSourceFilePos () const
 
void setInstanciationSourceFileName (const std::string &sourceFileName)
 
const std::string & getInstanciationSourceFileName () const
 
void setInstanciationSourceFilePos (const int)
 
int getInstanciationSourceFilePos () const
 
void addMessage (const sofa::helper::logging::Message &m) const
 
size_t countLoggedMessages (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
 
const std::deque< sofa::helper::logging::Message > & getLoggedMessages () const
 
const std::string getLoggedMessagesAsString (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const
 
void clearLoggedMessages () const
 
bool notMuted () const
 
const sofa::core::objectmodel::TagSetgetTags () const
 
bool hasTag (Tag t) const
 
void addTag (Tag t)
 
void removeTag (Tag t)
 
ComponentState getComponentState () const
 
bool isComponentStateValid () const
 
bool isComponentStateInvalid () const
 
 SOFA_ATTRIBUTE_DEPRECATED__TOBASECONSTRAINT () virtual const behavior
 
virtual bool parseField (const std::string &attribute, const std::string &value)
 
virtual bool hasField (const std::string &attribute) const
 
void parseFields (const std::list< std::string > &str)
 
virtual void parseFields (const std::map< std::string, std::string * > &str)
 
void writeDatas (std::map< std::string, std::string * > &str)=delete
 
void writeDatas (std::ostream &out, const std::string &separator=" ")
 
BaseDatafindData (const std::string &name) const
 
std::vector< BaseData * > findGlobalField (const std::string &name) const
 
BaseLinkfindLink (const std::string &name) const
 
std::vector< BaseLink * > findLinks (const std::string &name) const
 
virtual void updateLinks (bool logErrors=true)
 
BaseData::BaseInitData initData (::sofa::core::objectmodel::Data< T > *field, const char *name, const char *help, ::sofa::core::objectmodel::BaseData::DataFlags dataflags)
 
BaseData::BaseInitData initData (Data< T > *field, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 
Data< T >::InitData initData (Data< T > *field, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 
void addData (BaseData *f, const std::string &name)
 
void addData (BaseData *f)
 
void removeData (BaseData *f)
 
void addAlias (BaseData *field, const char *alias)
 
void addLink (BaseLink *l)
 
void addAlias (BaseLink *link, const char *alias)
 
const VecDatagetDataFields () const
 
const MapDatagetDataAliases () const
 
const VecLinkgetLinks () const
 
const MapLinkgetLinkAliases () const
 
virtual bool findDataLinkDest (BaseData *&ptr, const std::string &path, const BaseLink *link)
 
bool findLinkDest (T *&ptr, const std::string &path, const BaseLink *link)
 
const sofa::core::objectmodel::TagSetgetTags () const
 
bool hasTag (Tag t) const
 
void addTag (Tag t)
 
void removeTag (Tag t)
 
ComponentState getComponentState () const
 
bool isComponentStateValid () const
 
bool isComponentStateInvalid () const
 
 SOFA_ATTRIBUTE_DEPRECATED__TOBASECONSTRAINT () virtual const behavior
 

Protected Member Functions

 Fluid2D ()
 
 ~Fluid2D () override
 
template<int C>
int addPoint (int x, int y, int z, real v0, real v1, real iso)
 
int addFace (int p1, int p2, int p3)
 
- Protected Member Functions inherited from sofa::core::BehaviorModel
 BehaviorModel ()
 
 ~BehaviorModel () override
 
- Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
 BaseObject ()
 
 ~BaseObject () override
 
virtual void doUpdateInternal ()
 
void changeContextLink (BaseContext *before, BaseContext *&after)
 
void changeSlavesLink (BaseObject::SPtr ptr, std::size_t, bool add)
 
void trackInternalData (const BaseData &data)
 
void cleanTracker ()
 
bool hasDataChanged (const BaseData &data)
 
- Protected Member Functions inherited from sofa::core::objectmodel::Base
 Base ()
 
virtual ~Base ()
 
void initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 
void initData0 (BaseData *field, BaseData::BaseInitData &res, const char *name, const char *help, BaseData::DataFlags dataFlags)
 
void initData0 (Data< T > *field, typename Data< T >::InitData &res, const T &value, const char *name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
 
- Protected Member Functions inherited from sofa::core::IntrusiveObject
virtual ~IntrusiveObject ()=default
 

Additional Inherited Members

- Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject
static bool canCreate (T *, BaseContext *, BaseObjectDescription *)
 
static T::SPtr create (T *, BaseContext *context, BaseObjectDescription *arg)
 
- Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClassGetClass ()
 
static std::string shortName (const T *ptr=nullptr, BaseObjectDescription *=nullptr)
 

Attribute details

◆ f_cellwidth

sofa::core::objectmodel::Data<real> sofaeulerianfluid::Fluid2D::f_cellwidth

width of each cell

◆ f_dir

sofa::core::objectmodel::Data<vec2> sofaeulerianfluid::Fluid2D::f_dir

initial fluid surface normal

◆ f_height

sofa::core::objectmodel::Data<real> sofaeulerianfluid::Fluid2D::f_height

initial fluid height

◆ f_nx

sofa::core::objectmodel::Data<int> sofaeulerianfluid::Fluid2D::f_nx

grid size along x axis

◆ f_ny

sofa::core::objectmodel::Data<int> sofaeulerianfluid::Fluid2D::f_ny

grid size along y axis

◆ f_tstart

sofa::core::objectmodel::Data<real> sofaeulerianfluid::Fluid2D::f_tstart

starting time for fluid source

◆ f_tstop

sofa::core::objectmodel::Data<real> sofaeulerianfluid::Fluid2D::f_tstop

stopping time for fluid source

◆ facets

sofa::type::vector<Face> sofaeulerianfluid::Fluid2D::facets
protected

◆ fluid

Grid2D* sofaeulerianfluid::Fluid2D::fluid
protected

◆ fnext

Grid2D* sofaeulerianfluid::Fluid2D::fnext
protected

◆ ftemp

Grid2D* sofaeulerianfluid::Fluid2D::ftemp
protected

◆ planes

sofa::type::vector<CubeData> sofaeulerianfluid::Fluid2D::planes
protected

◆ points

sofa::type::vector<Vertex> sofaeulerianfluid::Fluid2D::points
protected

Constructor details

◆ Fluid2D()

sofaeulerianfluid::Fluid2D::Fluid2D ( )
protected

◆ ~Fluid2D()

sofaeulerianfluid::Fluid2D::~Fluid2D ( )
overrideprotected

Function details

◆ addFace()

int sofaeulerianfluid::Fluid2D::addFace ( int  p1,
int  p2,
int  p3 
)
inlineprotected

◆ addPoint()

template<int C>
int sofaeulerianfluid::Fluid2D::addPoint ( int  x,
int  y,
int  z,
real  v0,
real  v1,
real  iso 
)
inlineprotected

◆ computeBBox()

void sofaeulerianfluid::Fluid2D::computeBBox ( const sofa::core::ExecParams params,
bool  onlyVisible = false 
)
overridevirtual

◆ draw()

void sofaeulerianfluid::Fluid2D::draw ( const sofa::core::visual::VisualParams vparams)
overridevirtual

◆ getNx()

int sofaeulerianfluid::Fluid2D::getNx ( ) const
inline

◆ getNy()

int sofaeulerianfluid::Fluid2D::getNy ( ) const
inline

◆ init()

void sofaeulerianfluid::Fluid2D::init ( void  )
overridevirtual

◆ reset()

void sofaeulerianfluid::Fluid2D::reset ( )
overridevirtual

◆ setNx()

void sofaeulerianfluid::Fluid2D::setNx ( int  v)
inline

◆ setNy()

void sofaeulerianfluid::Fluid2D::setNy ( int  v)
inline

◆ SOFA_CLASS()

sofaeulerianfluid::Fluid2D::SOFA_CLASS ( Fluid2D  ,
sofa::core::BehaviorModel   
)

◆ updatePosition()

void sofaeulerianfluid::Fluid2D::updatePosition ( SReal  dt)
overridevirtual

◆ updateVisual()

void sofaeulerianfluid::Fluid2D::updateVisual ( )
virtual