This is the interface for FlowPlaneVertexThing, a C++ wrapper for a flow plane vertex This will be stored in a container and the ID will be stored in offset $KEXTCPP in the fortran flow plane vertex linked list. This inherits from Thing so we can use groups and extra variables. More...

#include <iflowplanevertexthing.h>

Public Member Functions
virtual const itasca::IThing *	getIThing () const =0
	Returns a const IThing pointer.

virtual itasca::IThing *	getIThing ()=0
	Returns a IThing pointer.

virtual FInt	getFortranOffset () const =0
	Return flow plane vertex fortran offset.

virtual bool	getHidden () const =0
	Returns true if vertex or host flow plane is hidden (host flow plane zone?)

virtual double	getAperture () const =0
	Return the fluid aperture.

virtual double	getMechanicalAperture () const =0
	Return the mechanical aperture.

virtual void	setMechanicalAperture (double d)=0
	set the mechanical aperture to input value

virtual double	getHydraulicAperture () const =0
	aperture limited by specified maximum

virtual double	getArea () const =0
	Return the flow plane area associated with this vertex.

virtual const IFlowPlaneThing *	getFlowPlane () const =0
	Return host flow plane.

virtual uint64	getFlowPlaneID () const =0
	Return host flow plane ID.

virtual const ISubcontactThing *	getSubcontact1 () const =0
	Return the first subcontact associated with this vertex.

virtual const ISubcontactThing *	getSubcontact2 () const =0
	Return the second subcontact associated with this vertex (nullptr for no subcontact)

virtual uint64	getSubcontact1_ID () const =0
	Return the first subcontact id associated with this vertex.

virtual uint64	getSubcontact2_ID () const =0
	Return the second subcontact id associated with this vertex (0 for no subcontact)

virtual double	getWeight1 () const =0
	Return weight associated with first subcontact (0 - 1)

virtual double	getWeight2 () const =0
	Return weight associated with second subcontact (0 - 1)

virtual const IFlowKnotThing *	getKnot () const =0
	Return the flow know associated with this vertex.

virtual uint64	getKnotID () const =0
	Return the id of flow know 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 double	getProppantConcentration () const =0
	Return the proppant concentration associated with this vertex.

virtual double	getProppantMassConc () const =0
	Return the proppant mass concentration associated with this vertex.

virtual double	getProppantThickness () const =0
	Return the proppant thickness associated with this vertex.

virtual double	getViscosity () const =0
	Return fluid viscosity.

virtual void	setProppantConcentration (double c)=0
	Set proppant volume concentration.

virtual void	setProppantMassConc (double c)=0
	Set proppant mass concentration.

virtual uint32	getPropertyIndex (const string &sc) const =0

virtual string	getProperties () const =0
	Return property names as a single string with names separated by commas.

virtual string	getPropertyName (uint32 index) const =0

virtual StringList	getPropertyNames () const =0
	returns a list of all the valid properties assigned to this flowplane

virtual base::Property	getProperty (uint32 index) const =0

virtual base::Property	getProperty (const string &propName) const =0

virtual bool	setProperty (string sprop, base::Property value)=0
	Set property corresponding to sprop equal to value.

virtual bool	setProperty (uint32 index, base::Property value)=0
	Set property corresponding to index equal to value.

virtual DVect3	getLocation () const =0
	Return the flow plane vertex location.

virtual double	getFFactor () const =0
	Return the F-factor.

virtual void	setFFactor (double d)=0
	set the F-factor

virtual double	getTransmisivity () const =0
	get transmisivity (for plotting only)

Static Public Attributes
static const TType	type_ = 0x52d8115b
	type used in IThing typing system

Detailed Description

This is the interface for FlowPlaneVertexThing, a C++ wrapper for a flow plane vertex This will be stored in a container and the ID will be stored in offset $KEXTCPP in the fortran flow plane vertex linked list. This inherits from Thing so we can use groups and extra variables.

Member Function Documentation

◆ getProperty() [1/2]

virtual base::Property block::IFlowPlaneVertexThing::getProperty ( const string & propName ) const

pure virtual

Returns value of flowplane property corresponding to propName
Returns 0 if propName is not recognized

◆ getProperty() [2/2]

virtual base::Property block::IFlowPlaneVertexThing::getProperty ( uint32 index ) const

pure virtual

Returns value of flowplane property corresponding to index
Returns 0 if index is not valid

◆ getPropertyIndex()

virtual uint32 block::IFlowPlaneVertexThing::getPropertyIndex ( const string & sc ) const

pure virtual

Given a property name, returns the index of the property assigned to this flowplane.

Note: Base 1, returns 0 if name is not found.

◆ getPropertyName()

virtual string block::IFlowPlaneVertexThing::getPropertyName ( uint32 index ) const

pure virtual

Given an index, returns the name of the property assigned to this flowplane.

Note: Base 1, returns string() if index is less then 1 or greater than the number of properties.

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

C:/Source/itasca-suite/3dec/block/interface/iflowplanevertexthing.h

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getProperty() [1/2]

◆ getProperty() [2/2]

◆ getPropertyIndex()

◆ getPropertyName()