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#include "base/src/property.h"
6
12namespace itasca
13{
14 class IThing;
15}
16
17namespace block
18{
19 class ISubcontactThing;
20 class IFlowKnotThing;
21 class IFlowPlaneThing;
22
29 {
30 public:
31
33 inline static const TType type_ = 0x52d8115b;
35 virtual const itasca::IThing * getIThing() const=0;
39 virtual FInt getFortranOffset() const=0;
41 virtual bool getHidden() const=0;
43 virtual double getAperture() const=0;
45 virtual double getMechanicalAperture() const=0;
47 virtual void setMechanicalAperture(double d) = 0;
49 virtual double getHydraulicAperture() const=0;
51 virtual double getArea() const=0;
53 virtual const IFlowPlaneThing * getFlowPlane() const=0;
55 virtual uint64 getFlowPlaneID() const=0;
57 virtual const ISubcontactThing * getSubcontact1() const=0;
59 virtual const ISubcontactThing * getSubcontact2() const=0;
61 virtual uint64 getSubcontact1_ID() const=0;
63 virtual uint64 getSubcontact2_ID() const=0;
65 virtual double getWeight1() const=0;
67 virtual double getWeight2() const=0;
69 virtual const IFlowKnotThing * getKnot() const=0;
71 virtual uint64 getKnotID() const=0;
73 virtual DVect2 getLocalCoords() const=0;
75 virtual double getProppantConcentration() const=0;
77 virtual double getProppantMassConc() const = 0;
79 virtual double getProppantThickness() const=0;
81 virtual double getViscosity() const=0;
83 virtual void setProppantConcentration(double c)=0;
85 virtual void setProppantMassConc(double c)=0;
88 virtual uint32 getPropertyIndex(const string &sc) const = 0;
90 virtual string getProperties() const = 0;
93 virtual string getPropertyName(uint32 index) const = 0;
95 virtual StringList getPropertyNames() const = 0;
98 virtual base::Property getProperty(uint32 index) const = 0;
101 virtual base::Property getProperty(const string& propName) const = 0;
103 virtual bool setProperty(string sprop, base::Property value) = 0;
105 virtual bool setProperty(uint32 index, base::Property value) = 0;
107 virtual DVect3 getLocation() const = 0;
109 virtual double getFFactor() const = 0;
111 virtual void setFFactor(double d) = 0;
113 virtual double getTransmisivity() const = 0;
114 };
115
116} // end namespace block
117// EOF
Definition basestring.h:71
Definition property.h:36
This is the interface for FlowKnotThing, a C++ wrapper for a flow knot This will be stored in a conta...
Definition iflowknotthing.h:30
Definition iflowplanething.h:29
This is the interface for FlowPlaneVertexThing, a C++ wrapper for a flow plane vertex This will be st...
Definition iflowplanevertexthing.h:29
virtual void setProppantConcentration(double c)=0
Set proppant volume concentration.
virtual double getTransmisivity() const =0
get transmisivity (for plotting only)
virtual string getProperties() const =0
Return property names as a single string with names separated by commas.
virtual uint64 getKnotID() const =0
Return the id of flow know associated with this vertex.
virtual bool getHidden() const =0
Returns true if vertex or host flow plane is hidden (host flow plane zone?)
virtual double getFFactor() const =0
Return the F-factor.
virtual uint64 getFlowPlaneID() const =0
Return host flow plane ID.
virtual double getAperture() const =0
Return the fluid aperture.
virtual double getProppantConcentration() const =0
Return the proppant concentration associated with this vertex.
virtual DVect3 getLocation() const =0
Return the flow plane vertex location.
virtual FInt getFortranOffset() const =0
Return flow plane vertex fortran offset.
virtual bool setProperty(uint32 index, base::Property value)=0
Set property corresponding to index equal to value.
virtual double getWeight2() const =0
Return weight associated with second subcontact (0 - 1)
virtual void setFFactor(double d)=0
set the F-factor
virtual const ISubcontactThing * getSubcontact1() const =0
Return the first subcontact associated with this vertex.
virtual DVect2 getLocalCoords() const =0
Return the local x and y coordinates in the coordinate system defined by the flow plane.
virtual uint64 getSubcontact1_ID() const =0
Return the first subcontact id associated with this vertex.
virtual StringList getPropertyNames() const =0
returns a list of all the valid properties assigned to this flowplane
virtual double getViscosity() const =0
Return fluid viscosity.
virtual double getWeight1() const =0
Return weight associated with first subcontact (0 - 1)
virtual double getMechanicalAperture() const =0
Return the mechanical aperture.
virtual double getProppantThickness() const =0
Return the proppant thickness associated with this vertex.
virtual const itasca::IThing * getIThing() const =0
Returns a const IThing pointer.
virtual uint64 getSubcontact2_ID() const =0
Return the second subcontact id associated with this vertex (0 for no subcontact)
virtual const IFlowKnotThing * getKnot() const =0
Return the flow know associated with this vertex.
static const TType type_
type used in IThing typing system
Definition iflowplanevertexthing.h:33
virtual string getPropertyName(uint32 index) const =0
virtual const ISubcontactThing * getSubcontact2() const =0
Return the second subcontact associated with this vertex (nullptr for no subcontact)
virtual double getHydraulicAperture() const =0
aperture limited by specified maximum
virtual double getProppantMassConc() const =0
Return the proppant mass concentration associated with this vertex.
virtual itasca::IThing * getIThing()=0
Returns a IThing pointer.
virtual void setProppantMassConc(double c)=0
Set proppant mass concentration.
virtual const IFlowPlaneThing * getFlowPlane() const =0
Return host flow plane.
virtual base::Property getProperty(uint32 index) const =0
virtual void setMechanicalAperture(double d)=0
set the mechanical aperture to input value
virtual bool setProperty(string sprop, base::Property value)=0
Set property corresponding to sprop equal to value.
virtual base::Property getProperty(const string &propName) const =0
virtual uint32 getPropertyIndex(const string &sc) const =0
virtual double getArea() const =0
Return the flow plane area associated with this vertex.
This is the interface for SubcontactThing, a class that holds extra data not in the fortran arrays....
Definition isubcontactthing.h:33
Base class for items that will be stored in containers.
Definition ithing.h:31
uint32 TType
class type indicator
Definition basedef.h:47
int64 FInt
Interface to provide access to 3DEC modules, global data, list of 3DEC entities, etc.
Definition iblockdef.h:14
Fortran to C++ type declarations.
namespace Itasca
Definition basememory.cpp:14