gmsh-TingyuanDoc  0.1
An Open-Source Timing-driven Analytical Mixed-size FPGA Placer
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Field Class Referenceabstract

#include <Field.h>

Inheritance diagram for Field:
Inheritance graph
[legend]

Public Member Functions

 Field ()
 
virtual ~Field ()
 
bool isDeprecated ()
 
virtual void update ()
 
virtual int numComponents () const
 
virtual bool isotropic () const
 
virtual double operator() (double x, double y, double z, GEntity *ge=nullptr)=0
 
virtual void operator() (double x, double y, double z, SVector3 &, GEntity *ge=0)
 
virtual void operator() (double x, double y, double z, SMetric3 &, GEntity *ge=nullptr)
 
virtual const char * getName ()=0
 
void putOnNewView (int viewTag=-1)
 
virtual std::string getDescription ()
 
FieldOption * getOption (const std::string &optionName)
 

Public Attributes

int id
 
std::map< std::string, FieldOption * > options
 
std::map< std::string, FieldCallback * > callbacks
 
bool updateNeeded
 

Protected Attributes

bool _deprecated
 

Detailed Description

Definition at line 103 of file Field.h.

Constructor & Destructor Documentation

◆ Field()

Field::Field ( )
inline

Definition at line 107 of file Field.h.

◆ ~Field()

Field::~Field ( )
virtual

Definition at line 51 of file Field.cpp.

Member Function Documentation

◆ getDescription()

virtual std::string Field::getDescription ( )
inlinevirtual

Reimplemented in ExtendField, DistanceField, OctreeField, ConstantField, RestrictField, MaxField, MinField, IntersectAnisoField, MinAnisoField, ParametricField, ExternalProcessField, MathEvalFieldAniso, MathEvalField, MeanField, LaplacianField, MaxEigenHessianField, CurvatureField, GradientField, ThresholdField, FrustumField, BallField, CylinderField, BoxField, LonLatField, BoundaryLayerField, automaticMeshSizeField, StructuredField, meshMetric, and FieldPython.

Definition at line 135 of file Field.h.

◆ getName()

virtual const char* Field::getName ( )
pure virtual

Implemented in ExtendField, DistanceField, OctreeField, ConstantField, RestrictField, MaxField, MinField, IntersectAnisoField, MinAnisoField, ParametricField, ExternalProcessField, MathEvalFieldAniso, MathEvalField, MeanField, LaplacianField, MaxEigenHessianField, CurvatureField, GradientField, ThresholdField, FrustumField, BallField, GenericField, CylinderField, BoxField, LonLatField, BoundaryLayerField, automaticMeshSizeField, StructuredField, meshMetric, and FieldPython.

◆ getOption()

FieldOption * Field::getOption ( const std::string &  optionName)

Definition at line 58 of file Field.cpp.

Here is the call graph for this function:

◆ isDeprecated()

bool Field::isDeprecated ( )
inline

Definition at line 109 of file Field.h.

◆ isotropic()

virtual bool Field::isotropic ( ) const
inlinevirtual

Reimplemented in IntersectAnisoField, MinAnisoField, MathEvalFieldAniso, BoundaryLayerField, automaticMeshSizeField, and meshMetric.

Definition at line 115 of file Field.h.

◆ numComponents()

virtual int Field::numComponents ( ) const
inlinevirtual

Definition at line 114 of file Field.h.

Referenced by _recombineIntoQuads().

Here is the caller graph for this function:

◆ operator()() [1/3]

virtual double Field::operator() ( double  x,
double  y,
double  z,
GEntity *  ge = nullptr 
)
pure virtual

Implemented in ExtendField, DistanceField, OctreeField, ConstantField, RestrictField, MaxField, MinField, IntersectAnisoField, MinAnisoField, ParametricField, ExternalProcessField, MathEvalFieldAniso, MathEvalField, MeanField, LaplacianField, MaxEigenHessianField, CurvatureField, GradientField, ThresholdField, FrustumField, BallField, GenericField, CylinderField, BoxField, LonLatField, BoundaryLayerField, automaticMeshSizeField, StructuredField, meshMetric, and FieldPython.

◆ operator()() [2/3]

virtual void Field::operator() ( double  x,
double  y,
double  z,
SMetric3 &  ,
GEntity *  ge = nullptr 
)
inlinevirtual

Reimplemented in IntersectAnisoField, MinAnisoField, MathEvalFieldAniso, BoundaryLayerField, meshMetric, and automaticMeshSizeField.

Definition at line 125 of file Field.h.

◆ operator()() [3/3]

virtual void Field::operator() ( double  x,
double  y,
double  z,
SVector3 &  ,
GEntity *  ge = 0 
)
inlinevirtual

Definition at line 120 of file Field.h.

◆ putOnNewView()

void Field::putOnNewView ( int  viewTag = -1)

Definition at line 3231 of file Field.cpp.

Here is the call graph for this function:

◆ update()

virtual void Field::update ( )
inlinevirtual

Reimplemented in DistanceField, OctreeField, and automaticMeshSizeField.

Definition at line 110 of file Field.h.

Referenced by GModel::computeSizeField(), and OctreeField::update().

Here is the caller graph for this function:

Member Data Documentation

◆ _deprecated

bool Field::_deprecated
protected

Definition at line 105 of file Field.h.

Referenced by isDeprecated().

◆ callbacks

std::map<std::string, FieldCallback *> Field::callbacks

Definition at line 113 of file Field.h.

Referenced by ~Field().

◆ id

int Field::id

Definition at line 111 of file Field.h.

Referenced by putOnNewView().

◆ options

std::map<std::string, FieldOption *> Field::options

Definition at line 112 of file Field.h.

Referenced by automaticMeshSizeField::automaticMeshSizeField(), BallField::BallField(), BoundaryLayerField::BoundaryLayerField(), BoxField::BoxField(), ConstantField::ConstantField(), CurvatureField::CurvatureField(), CylinderField::CylinderField(), DistanceField::DistanceField(), ExtendField::ExtendField(), ExternalProcessField::ExternalProcessField(), FrustumField::FrustumField(), getOption(), GradientField::GradientField(), IntersectAnisoField::IntersectAnisoField(), LaplacianField::LaplacianField(), LonLatField::LonLatField(), MathEvalField::MathEvalField(), MathEvalFieldAniso::MathEvalFieldAniso(), MaxEigenHessianField::MaxEigenHessianField(), MaxField::MaxField(), MeanField::MeanField(), MinAnisoField::MinAnisoField(), MinField::MinField(), OctreeField::OctreeField(), ParametricField::ParametricField(), RestrictField::RestrictField(), StructuredField::StructuredField(), ThresholdField::ThresholdField(), and ~Field().

◆ updateNeeded

bool Field::updateNeeded

Definition at line 129 of file Field.h.

Referenced by automaticMeshSizeField::automaticMeshSizeField(), BoundaryLayerField::BoundaryLayerField(), DistanceField::DistanceField(), ExtendField::ExtendField(), ExternalProcessField::ExternalProcessField(), IntersectAnisoField::IntersectAnisoField(), MathEvalField::MathEvalField(), MathEvalFieldAniso::MathEvalFieldAniso(), MaxField::MaxField(), MinAnisoField::MinAnisoField(), MinField::MinField(), OctreeField::OctreeField(), StructuredField::operator()(), BoundaryLayerField::operator()(), MathEvalField::operator()(), MathEvalFieldAniso::operator()(), ExternalProcessField::operator()(), ParametricField::operator()(), MinField::operator()(), MaxField::operator()(), ExtendField::operator()(), ParametricField::ParametricField(), BoundaryLayerField::removeAttractors(), StructuredField::StructuredField(), OctreeField::update(), and DistanceField::update().

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