Itasca C++ Interface
Loading...
Searching...
No Matches
iflowplanevertexthing.h
Go to the documentation of this file.
1#pragma once
2// iflowplanevertexthing.h
3
4#include "iblockdef.h"
5
11namespace itasca
12{
13 class IThing;
14}
15
16namespace block
17{
18 class ISubcontactThing;
19 class IFlowKnotThing;
20 class IFlowPlaneThing;
21
27 class IFlowPlaneVertexThing
28 {
29 public:
30
32 inline static const TType type_ = 0x52d8115b;
34 virtual const itasca::IThing * getIThing() const=0;
36 virtual itasca::IThing * getIThing()=0;
38 virtual FInt getFortranOffset() const=0;
40 virtual bool getHidden() const=0;
42 virtual double getAperture() const=0;
44 virtual double getMechanicalAperture() const=0;
46 virtual void setMechanicalAperture(double d) = 0;
48 virtual double getHydraulicAperture() const=0;
50 virtual double getArea() const=0;
52 virtual const IFlowPlaneThing * getFlowPlane() const=0;
54 virtual quint64 getFlowPlaneID() const=0;
56 virtual const ISubcontactThing * getSubcontact1() const=0;
58 virtual const ISubcontactThing * getSubcontact2() const=0;
60 virtual quint64 getSubcontact1_ID() const=0;
62 virtual quint64 getSubcontact2_ID() const=0;
64 virtual double getWeight1() const=0;
66 virtual double getWeight2() const=0;
68 virtual const IFlowKnotThing * getKnot() const=0;
70 virtual quint64 getKnotID() const=0;
72 virtual DVect2 getLocalCoords() const=0;
74 virtual double getProppantConcentration() const=0;
76 virtual double getProppantMassConc() const = 0;
78 virtual double getProppantThickness() const=0;
80 virtual double getViscosity() const=0;
82 virtual void setProppantConcentration(double c)=0;
84 virtual void setProppantMassConc(double c)=0;
87 virtual quint32 getPropertyIndex(const QString &sc) const = 0;
89 virtual QString getProperties() const = 0;
92 virtual QString getPropertyName(quint32 index) const = 0;
94 virtual QStringList getPropertyNames() const = 0;
97 virtual QVariant getProperty(uint index) const = 0;
100 virtual QVariant getProperty(const QString& propName) const = 0;
102 virtual bool setProperty(QString sprop, QVariant value) = 0;
104 virtual bool setProperty(uint index, QVariant value) = 0;
106 virtual DVect3 getLocation() const = 0;
108 virtual double getFFactor() const = 0;
110 virtual void setFFactor(double d) = 0;
112 virtual double getTransmisivity() const = 0;
113 };
114
115} // end namespace block
116// EOF
block::IFlowKnotThing
This is the interface for FlowKnotThing, a C++ wrapper for a flow knot This will be stored in a conta...
Definition iflowknotthing.h:30
block::IFlowPlaneThing
Definition iflowplanething.h:28
block::IFlowPlaneVertexThing
This is the interface for FlowPlaneVertexThing, a C++ wrapper for a flow plane vertex This will be st...
Definition iflowplanevertexthing.h:28
block::IFlowPlaneVertexThing::setProppantConcentration
virtual void setProppantConcentration(double c)=0
Set proppant volume concentration.
block::IFlowPlaneVertexThing::getTransmisivity
virtual double getTransmisivity() const =0
get transmisivity (for plotting only)
block::IFlowPlaneVertexThing::getPropertyIndex
virtual quint32 getPropertyIndex(const QString &sc) const =0
block::IFlowPlaneVertexThing::getHidden
virtual bool getHidden() const =0
Returns true if vertex or host flow plane is hidden (host flow plane zone?)
block::IFlowPlaneVertexThing::getFFactor
virtual double getFFactor() const =0
Return the F-factor.
block::IFlowPlaneVertexThing::getAperture
virtual double getAperture() const =0
Return the fluid aperture.
block::IFlowPlaneVertexThing::getProppantConcentration
virtual double getProppantConcentration() const =0
Return the proppant concentration associated with this vertex.
block::IFlowPlaneVertexThing::getPropertyNames
virtual QStringList getPropertyNames() const =0
returns a list of all the valid properties assigned to this flowplane
block::IFlowPlaneVertexThing::getLocation
virtual DVect3 getLocation() const =0
Return the flow plane vertex location.
block::IFlowPlaneVertexThing::getFortranOffset
virtual FInt getFortranOffset() const =0
Return flow plane vertex fortran offset.
block::IFlowPlaneVertexThing::getProperty
virtual QVariant getProperty(const QString &propName) const =0
block::IFlowPlaneVertexThing::getWeight2
virtual double getWeight2() const =0
Return weight associated with second subcontact (0 - 1)
block::IFlowPlaneVertexThing::getPropertyName
virtual QString getPropertyName(quint32 index) const =0
block::IFlowPlaneVertexThing::setFFactor
virtual void setFFactor(double d)=0
set the F-factor
block::IFlowPlaneVertexThing::setProperty
virtual bool setProperty(uint index, QVariant value)=0
Set property corresponding to index equal to value.
block::IFlowPlaneVertexThing::getSubcontact1
virtual const ISubcontactThing * getSubcontact1() const =0
Return the first subcontact associated with this vertex.
block::IFlowPlaneVertexThing::getLocalCoords
virtual DVect2 getLocalCoords() const =0
Return the local x and y coordinates in the coordinate system defined by the flow plane.
block::IFlowPlaneVertexThing::getViscosity
virtual double getViscosity() const =0
Return fluid viscosity.
block::IFlowPlaneVertexThing::getKnotID
virtual quint64 getKnotID() const =0
Return the id of flow know associated with this vertex.
block::IFlowPlaneVertexThing::getWeight1
virtual double getWeight1() const =0
Return weight associated with first subcontact (0 - 1)
block::IFlowPlaneVertexThing::getMechanicalAperture
virtual double getMechanicalAperture() const =0
Return the mechanical aperture.
block::IFlowPlaneVertexThing::getProperties
virtual QString getProperties() const =0
Return property names as a single string with names separated by commas.
block::IFlowPlaneVertexThing::getProppantThickness
virtual double getProppantThickness() const =0
Return the proppant thickness associated with this vertex.
block::IFlowPlaneVertexThing::getSubcontact2_ID
virtual quint64 getSubcontact2_ID() const =0
Return the second subcontact id associated with this vertex (0 for no subcontact)
block::IFlowPlaneVertexThing::getIThing
virtual const itasca::IThing * getIThing() const =0
Returns a const IThing pointer.
block::IFlowPlaneVertexThing::getKnot
virtual const IFlowKnotThing * getKnot() const =0
Return the flow know associated with this vertex.
block::IFlowPlaneVertexThing::type_
static const TType type_
type used in IThing typing system
Definition iflowplanevertexthing.h:32
block::IFlowPlaneVertexThing::getFlowPlaneID
virtual quint64 getFlowPlaneID() const =0
Return host flow plane ID.
block::IFlowPlaneVertexThing::getSubcontact2
virtual const ISubcontactThing * getSubcontact2() const =0
Return the second subcontact associated with this vertex (nullptr for no subcontact)
block::IFlowPlaneVertexThing::getHydraulicAperture
virtual double getHydraulicAperture() const =0
aperture limited by specified maximum
block::IFlowPlaneVertexThing::getProppantMassConc
virtual double getProppantMassConc() const =0
Return the proppant mass concentration associated with this vertex.
block::IFlowPlaneVertexThing::setProperty
virtual bool setProperty(QString sprop, QVariant value)=0
Set property corresponding to sprop equal to value.
block::IFlowPlaneVertexThing::getIThing
virtual itasca::IThing * getIThing()=0
Returns a IThing pointer.
block::IFlowPlaneVertexThing::setProppantMassConc
virtual void setProppantMassConc(double c)=0
Set proppant mass concentration.
block::IFlowPlaneVertexThing::getFlowPlane
virtual const IFlowPlaneThing * getFlowPlane() const =0
Return host flow plane.
block::IFlowPlaneVertexThing::getProperty
virtual QVariant getProperty(uint index) const =0
block::IFlowPlaneVertexThing::setMechanicalAperture
virtual void setMechanicalAperture(double d)=0
set the mechanical aperture to input value
block::IFlowPlaneVertexThing::getSubcontact1_ID
virtual quint64 getSubcontact1_ID() const =0
Return the first subcontact id associated with this vertex.
block::IFlowPlaneVertexThing::getArea
virtual double getArea() const =0
Return the flow plane area associated with this vertex.
block::ISubcontactThing
This is the interface for SubcontactThing, a class that holds extra data not in the fortran arrays....
Definition isubcontactthing.h:32
itasca::IThing
Base class for items that will be stored in containers.
Definition ithing.h:30
TType
uint32 TType
class type indicator
Definition basedef.h:46
FInt
int32 FInt
Interface to provide access to 3DEC modules, global data, list of 3DEC entities, etc.
Definition iblockdef.h:19
iblockdef.h
Fortran to C++ type declarations.
itasca
namespace Itasca
Definition basememory.cpp:10
Generated by doxygen 1.10.0