IFM FEFLOW Model Class

ifm.FeflowDoc

class ifm.FeflowDoc

The FeflowDoc class represents a FEFLOW model (fem or dac file) and is loaded by invoking the ifm.loadDocument() method.

See also

ifm.loadDocument

addAgeSpecies(species_name, species_type[, inherit_from])

Adds a new age species of type age, lifetime expectancy, or (optionally) based on an existing species.

Parameters:

species_name (str) – Name of new species, must be unique among all species.
species_type ({ifm.Enum.SPT_AGE, ifm.Enum.SPT_CHEM, ifm.Enum.SPT_EPR, ifm.Enum.SPT_INV, ifm.Enum.SPT_LTE}) – Type of species
inherit_from (int, optional) – nherit from existing species or -1 if create with defaults.

Returns:

index of new species, otherwise -1

Return type:

int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

addSpecies(species_name, inherit_from)

Adds a new species (optionally) based on an existing species.

Parameters:

species_name (str) – Name of new species, must be unique among all species.
inherit_from (int, optional) – Inherit from existing species or -1 if create with defaults.

Returns:

Index of new species, otherwise -1.

Return type:

int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

allowNodeMovement(node, x, y)

Returns a flag whether a horizontal node movement can be allowed.

Parameters:

node (int) – Node index
x (float) – Proposed local X and Y coordinates for the node n
y (float) – Proposed local X and Y coordinates for the node n

Returns:

Returns TRUE if the node movement can be allowed otherwise FALSE

Return type:

bool

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder

attachIfmModules(module)

Attach IFM module(s) to the current FEM problem.

Parameters:: module (str or list of str) – list of modules, or either module ID or module path.

budgetClose(budget)

IfmBudgetClose - Close budget evaluation data

Parameters:: budget (ifm.Budget) – budget data (given by ‘IfmBudgetCreate’)

Notes

It is required to free the allocated memory of the budget data

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetComponentsQueryFlowAtNode(budget, node)

Query the flow budget components at a given node

Parameters:

budget (ifm.Budget) – budget data (given by ‘IfmBudgetCreate’)
node (int) – Node ID to process

Returns:

tuple containing budget components lumped at the input node

Return type:

(float, float, float)

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetComponentsQueryFlowAtNode2(budget, node)

Query the flow budget components at a given node

Parameters:

budget (ifm.Budget) – budget data (given by ‘IfmBudgetCreate’)
node (int) – Node ID to process

Returns:

tuple containing budget components lumped at the input node

Return type:

(float, float, float, float)

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetComponentsQueryHeatAtNode(Budget, int)

Query the mass budget components at a given node

Parameters:

budget (ifm.Budget) – budget data (given by ‘IfmBudgetCreate’)
node (int) – Node ID to process

Returns:

tuple containing budget components lumped at the input node

Return type:

(float, float, float)

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetComponentsQueryHeatAtNode2()

budgetComponentsQueryHeatAtNode(Budget, int)

Query the mass budget components at a given node

Parameters:

budget (ifm.Budget) – budget data (given by ‘IfmBudgetCreate’)
node (int) – Node ID to process

Returns:

tuple containing budget components lumped at the input node

Return type:

(float, float, float, float)

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetComponentsQueryMassAtNode(budget, node)

Query the mass budget components at a given node

Parameters:

budget (ifm.Budget) – budget data (given by ‘IfmBudgetCreate’)
node (int) – Node ID to process

Returns:

tuple containing budget components lumped at the input node

Return type:

(float, float, float)

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetComponentsQueryMassAtNode2()

budgetComponentsQueryMassAtNode(budget, node)

Query the mass budget components at a given node

Parameters:

budget (ifm.Budget) – budget data (given by ‘IfmBudgetCreate’)
node (int) – Node ID to process

Returns:

tuple containing budget components lumped at the input node

Return type:

(float, float, float, float)

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetCompute(problem_class, nodes, return_nodal)

Compute budget for a given number of nodes

Parameters:

problem_class ({ifm.Enum.PCLS_FLOW, ifm.Enum.PCLS_MASS_TRANSPORT, ifm.Enum.PCLS_HEAT_TRANSPORT}) – The type of budget (flow budget, mass budget or heat budget)
nodes (list of int) – List of node numbers for which to perform budgeting
return_nodal (bool) – If True, return an array with nodal boundary fluxes.

Returns:

Various budget components lumped over all nodes specified by pNodes

Return type:

ifm.BudgetResultEx

Notes

This function is more effective for a reduced number nodes than IfmBudgetCreate/IfmBudgetvalue

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetComputeNodal(problem_class, nodes, return_nodal)

Compute nodal budget.

Parameters:

problem_class ({ifm.Enum.PCLS_FLOW, ifm.Enum.PCLS_MASS_TRANSPORT, ifm.Enum.PCLS_HEAT_TRANSPORT}) – The type of budget (flow budget, mass budget or heat budget)
nodes (list of int) – List of node numbers for which to perform budgeting
return_nodal (bool) – if True result contains nodal budgets, too.

Returns:

Various budget components lumped over all nodes specified by pNodes

Return type:

ifm.NodalBudget

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

Examples

>>> budget = ifm.budgetComputeNodal(0, [1,2,3,11,12,13], True)
>>> print budget

budgetComputeSubdomain(problem_class, elements)

Compute budget for given subdomain (elements)

Parameters:

problem_class ({ifm.Enum.PCLS_FLOW, ifm.Enum.PCLS_MASS_TRANSPORT, ifm.Enum.PCLS_HEAT_TRANSPORT}) – The type of budget (flow budget, mass budget or heat budget)
elements (list of int) – elements: list of element numbers making up the subdomain for which to perform budgeting

Returns:

SubdomainBudget Object containing various budget components lumped over all nodes associated with the elements specified in elements.

Return type:

ifm.SubdomainBudget

Examples

>>> budget = ifm.budgetComputeSubdomain(0, [1,2,3,11,12,13])
>>> print budget

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetComputeSubdomainTransfer(problem_class, elements, nodes[, compute_nodal_budget])

Compute transfer budget for given subdomain (elements) and node mask (to be applied to subdomain boundary nodes)

Parameters:

problem_class ({ifm.Enum.PCLS_FLOW, ifm.Enum.PCLS_MASS_TRANSPORT, ifm.Enum.PCLS_HEAT_TRANSPORT}) – The type of budget (flow budget, mass budget or heat budget)
elements ([int]) – list of element numbers making up the subdomain for which to perform budgeting
nodes ([int]) – list of node numbers for which to perform subdomain-transfer budgeting, any nodes in this list that are not located on subdomain boundary will be ignored
compute_nodal_budget (bool) – If true, the returned object instance contains a list of nodal fluxes as a class member.

Returns:

Object containing various budget components lumped over all nodes specified by nodes

Return type:

ifm.SubdomainTransferBudget

Examples

>>> budget = ifm.budgetComputeSubdomainTransfer(0, [1,2,3,11,12,13], [5,6,7,15,16,17], True)
>>> print(budget)

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetFlowCreate()

Create fluid flow budget evaluation data and build up the matrix

IMPORTANT: In transient applications the budget evaluation should be put in a ‘PostTimeStep’ callback rather than in the ‘PostFlowSimulation’ because transient budget vectors are yet incomplete at that simulation stage and incorrect flux values result!

Returns:: budget object
Return type:: ifm.Budget

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetHeatCreate()

Create heat budget evaluation data and build up the matrix

Budget evaluation requires in steady state or at each time step the sequence of three function calls, e.g.,

IMPORTANT: In transient applications the budget evaluation should be put in a ‘PostTimeStep’ callback rather than in the ‘PostHeatSimulation’ because transient budget vectors are yet incomplete at that simulation stage and incorrect flux values result!

Returns:: budget object
Return type:: ifm.Budget

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetMassCreate()

Create mass budget evaluation data and build up the matrix

Budget evaluation requires in steady state or at each time step the sequence of three function calls, e.g.,

IMPORTANT: In transient applications the budget evaluation should be put in a ‘PostTimeStep’ callback rather than in the ‘PostHeatSimulation’ because transient budget vectors are yet incomplete at that simulation stage and incorrect flux values result!

Returns:: budget object
Return type:: ifm.Budget

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetQueryFlowAtNode(budget, int)

IfmBudgetQueryFlowAtNode - Retrieve the value of fluid flux at a node and current time

Parameters:

budget (ifm.Budget) – budget object
node (int) – Node number

Returns:

The fluid flux value at a given node and at current time

Return type:

float

Notes

The value is related to the current imulation time Physical unit is [m3/d] Indexing (of nodes) starts with 0.

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetQueryHeatAtNode(budget, int)

Retrieve the value of heat flux at a node and current time

Parameters:

budget (ifm.Budget) – budget data (given by ‘IfmBudgetCreate’)
node (int) – Node number

Returns:

The heat flux value of at a given node and at current time

Return type:

float

Notes

The value is related to the current simulation time Physical unit is [J/d] Indexing (of nodes) starts with 0.

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

budgetQueryMassAtNode(Budget, int)

IfmBudgetQueryMassAtNode - Retrieve the value of mass flux at a node and current time

Parameters:

Budget (Ifm.Budget) – budget object (returned by ‘IfmBudgetCreate’)
node (int) – Node index

Returns:

The mass flux value of at a given node and at current time

Return type:

float

Notes

The value is related to the current simulation time Physical unit is [g/d] Indexing (of nodes) starts with 0.

See also

budgetFlowCreate, budgetMassCreate, budgetHeatCreate, budgetQueryFlowAtNode, budgetComponentsQueryFlowAtNode, budgetComponentsQueryFlowAtNode2, budgetQueryMassAtNode, budgetComponentsQueryMassAtNode, budgetComponentsQueryMassAtNode2, budgetQueryHeatAtNode, budgetComponentsQueryHeatAtNode, budgetComponentsQueryHeatAtNode2, budgetClose, budgetCompute, budgetComputeNodal, budgetComputeSubdomain, budgetComputeSubdomainTransfer

clearSelectionItem(selection_type, sel_index, item_index)

Remove an item from a selection.

Parameters:

selection_type ({ifm.Enum.SEL_EDGES, ifm.Enum.SEL_ELEMENTAL, ifm.Enum.SEL_FACES, ifm.Enum.SEL_FRACS, ifm.Enum.SEL_NODAL}) – type of selection
sel_index (int) – index of selection
item_index (int) – index of the item

Examples

>>> sel_id = doc.findSelection(ifm.Enum.SEL_NODAL, "west")
>>> doc.clearSelectionItem(ifm.Enum.SEL_NODAL, sel_id, 1)

closeDocument(): Closes the current Document.

createElementalRefDistr(dist_name)

IfmCreateElementalRefDistr - Create a new elemental reference distribution with specified name.

Parameters:: dist_name (str) – Elemental reference distribution name string
Returns:: ID of new created elemental reference distribution (beginning with 0), or -1 if no distribution created becasue of a elemental reference distribution with specified name already exists, the proposed name is invalid, or empty
Return type:: int

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

createFracElement(node_left, node_right, frac_type, frac_mode, frac_law)

Create a fracture element for given node numbers and type, mode and law.

Parameters:

node_left (int) – ‘Left’ node index (upper slice for ifm.Enum.FRAC_V)
node_right (int) – ‘Right’ node index (lower slice for ifm.Enum.FRAC_V)
frac_type ({ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, ifm.Enum.FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

index of fracture element created

Return type:

int

Warning

This function is available only for layered models, not for unstructured meshes.

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

createFracElement2(node_left, node_right, frac_type, frac_mode, frac_law, node_type)

Create a fracture element for given node numbers and type, mode, law and node type/

Parameters:

node_left (int) – ‘Left’ node index (upper slice for ifm.Enum.FRAC_V)
node_right (int) – ‘Right’ node index (lower slice for ifm.Enum.FRAC_V)
frac_type ({ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, ifm.Enum.FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law
node_type ({ifm.Enum.FRAC_COMMON_NODE_TYPE, FRAC_DUAL_NODE_TYPE}) – Dual node type

Returns:

index of fracture element created

Return type:

int

Warning

This function is available only for layered models, not for unstructured meshes.

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

createMeshFromPlane(plane)

Create a cross-section from a (tilted) plane through model.

Parameters:: list (list of 2 tuples) – list of 2 x-y-z tuples: start point and vector [(double, double, double),(double, double, double)]
Returns:: FemMesh Instance
Return type:: ifm.FemMesh

Examples

>>> plane = [(2915.857, 4474.158, 4.58), (0, 1, 0)]
>>> femmesh = doc.createMeshFromPlane(plane)

See also

ifm.FemMesh

createMeshFromSurfaceLine(line)

IfmCreateMeshFromSurfaceLine - Create a cross-section from a line object.

Parameters:: line (list of points) – List of point coordinates
Returns:: FemMesh Instance
Return type:: ifm.FemMesh

Examples

>>> line = [(2474.5,3703.85), (8290.74, 4026.29)]
>>> femmesh = doc.createMeshFromSurfaceLine(line)

See also

ifm.FemMesh

createNodalRefDistr(dist_name)

IfmCreateNodalRefDistr - Create a new nodal reference distribution with specified name.

Parameters:: dist_name (str) – Nodal reference distribution name string
Returns:: ID of new created nodal reference distribution (beginning with 0) or -1 if nodal reference distribution with specified name already exists
Return type:: int

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

createParticleTracer()

Create a Particle Tracer Instance

Returns:: Particle Tracer Instance
Return type:: ifm.ParticleTracer

Examples

>>> tracer = doc.createParticleTracer()

See also

ifm.ParticleTracer

createSelection(sel_type, sel_name)

IfmCreateSelection - Create a selection of a certain type and name

Parameters:

sel_type (Ifm.Enum.SEL_<Enum>) – Selection type
sel_name (str) – Selection name

Returns:

The index of the selection or -1 if not possible. Creating a selection with a name that already exists returns the index of the existing selection

Return type:

int

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

createWellManager()

Create a Well Manager Instance.

createWellManager() returns a snapshot of the Well Manager at the time the function is called. The user should discard the object after info is queried/operations are applied and re-create it later on if required.

Returns:: Well Manager Instance
Return type:: ifm.WellManager

Examples

>>> wm = doc.createWellManager()

See also

ifm.WellManager

deleteElementalRefDistr(sel_id)

Delete the elemental reference distribution with id rID.

Parameters:: sel_id (int) – Elemental reference distribution id [0, … ]

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

deleteFiniteElements(elements)

IfmDeleteFiniteElements - Delete finite elements as listed in ‘Elist’ of length ‘nE’

Parameters:: elements ([int]) – List of element indices to be deleted
Returns:: True if succesful, False if failed
Return type:: bool

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

deleteFracElement(dfe_id)

IfmDeleteFracElement - Delete fracture element of given number (index).

Parameters:: dfe_id (int) – Fracture element index to be deleted

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

deleteFracElements(dfe_list)

Delete fracture elements by given index.

Parameters:: dfe_list ([int]) – Fracture element indices to be deleted

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

deleteNodalRefDistr(dist_id)

Delete the nodal reference distribution with id dist_id.

Parameters:: dist_id (int) – Nodal user distribution ID [0, … ]

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

deleteSelection(sel_type, sel_id)

IfmDeleteSelection - Delete a selection by type and index

Parameters:

sel_type (Ifm.Enum.SEL_<x>) – selection type
sel_id (int) – Selection index (must be > 0)

Returns:

True if the selection was deleted successfully otherwise false

Return type:

bool

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

deleteSteps(steps, filename)

Delete time step from the current DAC file.

Parameters:

steps ([int]) – list of time steps to delete
filename (str, optional) – filename of file to save output

Note

Steps are numbered by their position in the dac file, not their time step number

enableElementalRefDistrRecording(dist_id, enable)

Enable or disable recording of elemental reference distribution to DAC file.

Parameters:

dist_id (int) – Elemental reference distribution ID [0, … ]
enable (bool) – Enable recording flag

Returns:

Previous value of the flag.

Return type:

bool

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

enableNodalRefDistrRecording(dist_id, enable)

Enable or disable recording of nodal reference distribution to DAC file.

Parameters:

dist_id (int) – Nodal reference distribution ID [0, … ]
enable (bool) – Enable recording flag

Returns:

Previous value of the flag.

Return type:

bool

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

enableParamRecording(param, enable)

Enable recording of a parameter into DAC steps.

This functions tells FEFLOW to store additional paramter into the DAC file. Note that this function must be called before the simulator is started.

Parameters:

param (int or (int, str)) – Parameter identification code IfmP_* or
enable (bool or [bool]) – True to enable parameter recording

Examples

>>> doc.enableParamRecording(ifm.Enum.P_COND, True)

See also

enableSpatialIndex(enable)

Enables a spatial index to accelerate elemental search The spatial index accelerates all functions of type IfmGet…AtXYZ and IfmGet…AtXYSlice. IfmEnableSpatialIndex() does not build the index directly. Instead, building the index is delayed until calling the first access function, e.g., IfmGetResultsFlowHeadValueAtXYZ().

Parameters:: enable (bool) – True to enable/False to disable spatial index
Returns:: the previous spatial index status
Return type:: bool

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

enumSelectionItems(sel_type, sel_index, start)

Return the next item in the selection after start. Use this function to iterate items of a selection defined by sel_type and sel_index.

Parameters:

sel_type (Ifm.Enum.SEL_<x>) – Selection type
sel_index (int) – Selection index
start (int) – Start position: initialize to -1 to enum all items

Returns:

The next item found in the selection with a value greater or equal start

Return type:

int

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

findElementAtXY(x, y, relax)

Find the finite element at a given location IfmFindElementAtXY() searches for the element beneath a given location. Additionally, a relaxation space around the element can be specified to locate border elements safely. By default, the relax parameter can be set to 0. The performance of the function can be remarkably improved by using a spatial index. (see IfmEnableSpatialIndex())

Parameters:

x (float) – Location X coordinate
y (float) – Location Y coordinate
relax (float) – Additional space around element treated as inside

Returns:

The index of the element at (x,y) or -1 if the location is outside of the model domain.

Return type:

int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

findElementAtXYZ(x, y, z)

Find the finite element at a given 3D location IfmFindElementAtXYZ() searches for the element at a given (x,y,z) location. NOTE! The performance of the function can be remarkably improved by using a spatial index. (see IfmEnableSpatialIndex())

Parameters:

x (float) – Location X coordinate
y (float) – Location Y coordinate
z (float) – Location Z coordinate

Returns:

The index of the element at (x,y,z) or -1 if the location is outside of the model domain

Return type:

int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

findNodeAtXY(x, y, dist)

Find the nearest node at a given location IfmFindNodeAtXY() searches the nearest node around the given location in the distance specified by dist. If a node can be found, the function returns the node number otherwise -1. The distance between the found node and the given location is returned in dist.

Parameters:

x (float) – Location X coordinate
y (float) – Location Y coordinate
dist (float*) – Max. distance between node and location (in and out)

Returns:

The index of the nearest node at (x,y) or -1 if no node can be found in the given distance.

Return type:

int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

findNodeAtXYZ(x, y, z, dist)

Find the nearest node at a given 3D location IfmFindNodeAtXYZ() searches the nearest node around the given (x,y,z) location in the distance specified by dist. If a node can be found, the function returns the node number otherwise -1. The distance between the found node and the given location is returned in dist.

Parameters:

x (float) – Location X coordinate (local)
y (float) – Location Y coordinate (local)
z (float) – Location Z coordinate
dist (float) – Max. distance between node and location (in and out)

Returns:

The index of the nearest node at (x,y,z) or -1 if no node can be found in the given distance.

Return type:

int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

findObsByLabel(label)

Find the index of an observation point by its label

Parameters:: label (str) – Observation point label
Returns:: The index (observation point ID) of an observation point Index starts at 0
Return type:: int

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

findSelection(sel_type, sel_name)

Find a selection index by type and name

Parameters:

sel_type (Ifm.Enum.SEL_<x>) – Selection type
sel_name (str) – Selection name, <null> or “<current>” for current selection

Returns:

The index of the selection or -1 if not found

Return type:

int

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

findSpecies(species_name)

Find Id of a species by its name

Parameters:: species_name (str) – Name of species
Returns:: The Id of the species or -1 if not found
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getAMRErrorTolerance()

Get the AMR Error Tolerance

Returns:: AMR Error tolerance
Return type:: float

getAMREstimatorType()

Retrieve the of Adaptive Mesh Refinement (AMR) error estimator type

Returns:: The AMR error estimator type flag
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getAMRType()

IfmGetAMRType - Retrieve the type of Adaptive Mesh Refinement (AMR) technique

Returns:: The AMR flag
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getAbsoluteSimulationTime()

Retrieve the absolute simulation time of the current time step (t >=0.)

Returns:: The absolute simulation time (t >=0.). Physical unit is [d].
Return type:: float

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getAccelerationHeadTimeValue(node)

IfmGetAccelerationHeadTimeValue - Retrieve the acceleration value for the hydraulic head at the current time step for a transient flow problem in using a predictor-corrector time stepping scheme

Parameters:: node (int) – Node index
Returns:: The acceleration value for the hydraulic head. Physical unit is [m/d], The value is related to the current simulation time.
Return type:: float

See also

getAccelerationHeatTimeValue(node)

Retrieve the acceleration value for temperature (heat) at the current time step for a transient heat transport problem in using a predictor-corrector time stepping scheme

Parameters:

node (int) – Node index

Returns:

The acceleration value for the temperature (heat). Physical unit is [deg C / d], The value is related to the current
simulation time Indexing starts with 0.

See also

getAccelerationMassTimeValue(node)

Retrieve the acceleration value for mass (concentration) at the current time step for a transient mass transport problem in using a predictor-corrector time stepping scheme

Parameters:

node (int) – Node index

Returns:

The acceleration value for the mass (concentration). Physical unit is [mg/l/d], The value is related to the current simulation time
Indexing starts with 0.

See also

getAmrElementRefinement(element)

Check if an element is marked for either refining or derefining IfmGetAmrElementRefinement() can be used to check the markup state of an element.

Parameters:: element (int) – Element index to be marked

See also

setAmrElementRefinement, getAmrElementRefinement, getAmrErrorTolerance, setAmrErrorTolerance

getBHEArrayFlowDischarge(bhearray_index)

Retrieve flow discharge of BHE array at given index ‘bhearray_index’

Parameters:: bhearray_index (int) – Index of BHE array (index starts at 0)
Returns:: flow discharge [m3/d] otherwise 0.0 if function failed
Return type:: float

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHEArrayInTemperature(bhearray_index)

Retrieve in temperature of BHE array at given index ‘bhearray_index’

Parameters:: bhearray_index (int) – Index of BHE (index starts at 0)
Returns:: Temperature [C] otherwise 0.0 if function failed
Return type:: float

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHEArrayName(bhearray_index)

Retrieve the name of BHE array.

Parameters:: bhearray_index (int) – Index of BHE (index starts at 0)
Returns:: Name if BHE array exists otherwise 0 if no BHE array exists
Return type:: str

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHEArrayNumber()

GetBHEArrayNumber()

Retrieve the number of BHE

Returns:: positive number > 0 if BHE array exists otherwise 0 if no BHE array exists -1 if function failed
Return type:: int

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHEArrayOutTemperature(bhearray_index)

Retrieve out temperature of BHE array at given index ‘nIndex’

Parameters:: bhearray_index (int) – Index of BHE array (index starts at 0)
Returns:: out temperature [oC] otherwise 0.0 if function failed
Return type:: float

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHEFlowDischarge(bhe_index)

Retrieve flow discharge of BHE at given index ‘bhe_index’

Parameters:: bhe_index (int) – Index of BHE (index starts at 0)
Returns:: flow discharge [m3/d] otherwise 0.0 if function failed
Return type:: float

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHEHeatInputRate(bhe_index)

Retrieve heat input rate of BHE at given index ‘bhe_index’

Parameters:: bhe_index (int) – Index of BHE (index starts at 0)
Returns:: heat input rate [J/d] otherwise 0.0 if function failed
Return type:: float

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHEInletTemperature(bhe_index)

Retrieve inlet temperature of BHE at given index ‘bhe_index’

Parameters:: bhe_index (int) – Index of BHE (index starts at 0)
Returns:: inlet temperature [oC] otherwise 0.0 if function failed
Return type:: float

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHENumber()

GetBHENumber()

Retrieve the number of BHE

Returns:: positive number > 0 if BHE exists otherwise 0 if no BHE exists -1 if function failed
Return type:: float

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHEOutletTemperature(bhe_index)

Retrieve outlet temperature of BHE at given index ‘bhe_index’

Parameters:: bhe_index (int) – Index of BHE (index starts at 0)
Returns:: outlet temperature [oC] otherwise 0.0 if function failed
Return type:: float

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHEReferenceNode(bhe_index)

Retrieve reference node of BHE at given index ‘bhe_index’

Parameters:: bhe_index (int) – Index of BHE (index starts at 0)
Returns:: positive number > 0 if BHE exists otherwise -1 if function failed
Return type:: int

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBHEType(int)

Retrieve type of BHE at given index ‘nIndex’

Parameters:: nIndex (int) – Index of BHE (index starts at 0)
Returns:: BHE type
Return type:: {ifm.Enum.TYPE_2U, ifm.Enum.TYPE_1U, ifm.Enum.TYPE_CXA, ifm.Enum.TYPE_CXC}

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getBcFlowSpec(node)

Test integral behavior of flow boundary conditions

Parameters:: node (int) – Node index
Returns:: boundary mass condition specification (ifm.Enum.INTEGRAL_BC=1) or (ifm.Enum.NONINTEGRAL_BC=0) Indexing starts with 0.
Return type:: int

See also

getBcFlowTimeDependency(node)

Retrieve time-dependency of flow boundary conditions

Parameters:: node (int) – Node number
Returns:: Whether a boundary flow condition is time-dependent or steady-state 0 = steady-state > 0 = ID number of time-dependent power function Indexing starts with 0.
Return type:: int

See also

getBcFlowType(node)

Retrieve the type of boundary flow conditions.

Parameters:: node (int) – Node number
Returns:: The type of boundary flow conditions
Return type:: {ifm.Enum.BC_NO, ifm.Enum.BC_DIRICHLET, ifm.Enum.BC_NEUMANN, ifm.Enum.BC_CAUCHY, ifm.Enum.BC_SINGLE_WELL, ifm.Enum.BC_GRADIENT_FTYPE}

See also

getBcFlowValue(node)

IfmGetBcFlowValue - Retrieve the value of boundary flow conditions

Parameters:: node (int) – Node number
Returns:: The value of boundary flow conditions
Return type:: float

Notes

The value is related to the current simulation time

See also

getBcHeatSpec(node)

Test integral behavior of heat boundary conditions

Parameters:: node (int) – Node number
Returns:: boundary heat condition specification (ifm.Enum.INTEGRAL_BC=1) or (ifm.Enum.NONINTEGRAL_BC=0) Indexing starts with 0.
Return type:: int

See also

getBcHeatTimeDependency(node)

Retrieve time-dependency of heat transport boundary conditions

Parameters:: node (int) – node index
Returns:: Whether a boundary heat transport condition is time-dependent or steady-state 0 = steady-state > 0 = ID number of time-dependent power function.
Return type:: int

getBcHeatType(node)

IfmGetBcHeatType - Retrieve the type of boundary heat transport conditions

Parameters:: node (int) – Node index
Returns:: The type of heat conditions
Return type:: {ifm.Enum.IfmBC_NO, ifm.Enum.BC_DIRICHLET, ifm.Enum.BC_NEUMANN, ifm.Enum.BC_CAUCHY, ifm.Enum.BC_SINGLE_WELL, ifm.Enum.BC_GRADIENT_FTYPE}

See also

getBcHeatValue(node)

IfmGetBcHeatValue - Retrieve the value of boundary heat transport conditions

Parameters:: node (int) – Node number
Returns:: The value of boundary heat transport conditions
Return type:: float

Notes

The value is related to the current simulation time Indexing starts with 0.

See also

getBcMassSpec(node)

Test integral behavior of mass boundary conditions.

Parameters:: node (int) – Node number
Returns:: boundary mass condition specification
Return type:: {Ifm.Enum.INTEGRAL_BC, ifm.Enum.NONINTEGRAL_BC}

See also

getBcMassTimeDependency(node)

Retrieve time-dependency of mass transport boundary conditions.

Parameters:: node (int) – Node number
Returns:: Time Series ID or 0 if steady-state
Return type:: int

See also

getBcMassType(node)

IfmGetBcMassType - Retrieve the type of boundary mass transport conditions

Parameters:: node (int) – Node number
Returns:: The type of mass conditions
Return type:: {ifm.Enum.IfmBC_NO, ifm.Enum.BC_DIRICHLET, ifm.Enum.BC_NEUMANN, ifm.Enum.BC_CAUCHY, ifm.Enum.BC_SINGLE_WELL, ifm.Enum.BC_GRADIENT_FTYPE}

See also

getBcMassValue(node)

Retrieve the value of boundary mass transport conditions

Parameters:: node (int) – Node number
Returns:: The value of boundary mass transport conditions
Return type:: float

See also

getBccFlowTimeDependency(node, type_bcc)

IfmGetBccFlowTimeDependency - Retrieve time-dependency of flow constraint conditions

fm.Enum.MIN_BCC_TYPE (0) - Minimum constraint
ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint
ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport)
ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

Parameters:

node (int) – Node number
type_bcc ({ifm.Enum.MIN_BCC_TYPE, ifm.Enum.MAX_BCC_TYPE, ifm.Enum.HMIN_BCC_TYPE, ifm.Enum.HMAX_BCC_TYPE}) – Constraint Flag

Returns:

Whether a boundary flow constraint is time-dependent or steady-state 0 = steady-state > 0 = ID number of time-dependent power function Indexing starts with 0.

Return type:

int

See also

getBccFlowType(node)

IfmGetBccFlowType - Retrieve the type of boundary flow constraint condition

ifm.Enum.BCC_NONE (0) = no constraint
ifm.Enum.BCC_DIRICHLET (1) = Dirichlet constraint
ifm.Enum.BCC_NEUMANN (2) = Neumann constraint
ifm.Enum.BCC_CAUCHY (3) = Cauchy constraint
ifm.Enum.BCC_SINGLE_WELL (4) = Single well constraint
ifm.Enum.BCC_SPECIAL_3RD_BCC (6) = Special 3rd kind flow head B.C.’s constraint

Parameters:: node (int) – Node number
Returns:: The type of boundary flow constraint condition
Return type:: int

See also

getBccFlowValue(node, type_bcc)

IfmGetBccFlowValue - Retrieve the value of boundary flow constraint

ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint
ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint
ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport)
ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport

Parameters:

node (int) – Node number
type_bcc (int) – Constraint flag

Returns:

The value of boundary flow constraint

Return type:

float

Notes

The value is related to the current simulation time. Indexing starts with 0.

See also

getBccHeatTimeDependency(node, bcc_type)

Retrieve time-dependency of heat transport boundary constraint.

Parameters:

node (int) – node index
bcc_type ({ifm.Enum.MIN_BCC_TYPE, ifm.Enum.MAX_BCC_TYPE, ifm.Enum.IfmHMIN_BCC_TYPE , ifm.Enum.IfmHMAX_BCC_TYPE , ifm.Enum. }) – constraint flag, IfmMIN_BCC_TYPE (0) - Minimum constraint IfmMAX_BCC_TYPE (1) - Maximum constraint IfmHMIN_BCC_TYPE (2) - Head minimum constraint (for transport) IfmHMAX_BCC_TYPE (3) - Head maximum constraint (for transport).

Returns:

Whether a boundary heat transport constraint is time-dependent or steady-state 0 = steady-state > 0 = ID number of time-dependent power function Indexing starts with 0.

Return type:

int

getBccHeatType(node)

IfmGetBccHeatType - Retrieve the type of boundary heat transport constraint

ifm.Enum.BCC_NONE (0) = no constraint
ifm.Enum.BCC_DIRICHLET (1) = Dirichlet constraint
ifm.Enum.BCC_NEUMANN (2) = Neumann constraint
ifm.Enum.BCC_CAUCHY (3) = Cauchy constraint
ifm.Enum.BCC_SINGLE_WELL (4) = Single well constraint
ifm.Enum.BCC_SPECIAL_3RD_BCC (6) = Special 3rd kind flow head B.C.’s constraint

Parameters:: node (int) – Node number
Returns:: The value of boundary heat transport constraint:
Return type:: int

See also

getBccHeatValue(node, type_bcc)

IfmGetBccHeatValue - Retrieve the value of boundary heat transport constraint

ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint
ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint
ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport)
ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

Parameters:

node (int) – Node number
type_bcc (int) – Constraint flag

Returns:

The value of boundary heat transport constraint

Return type:

int

Notes

The value is related to the current simulation time Indexing starts with 0.

See also

getBccMassTimeDependency(node, type_bcc)

IfmGetBccMassTimeDependency - Retrieve time-dependency of mass transport boundary constraint

ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint
ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint
ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport)
ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

Parameters:

node (int) – Node number
type_bcc (int) – Constraint flag

Returns:

time series ID or 0 if steady-state

Return type:

int

See also

getBccMassType(node)

IfmGetBccMassType - Retrieve the type of boundary mass transport constraint

ifm.Enum.BCC_NONE (0) = no constraint
ifm.Enum.BCC_DIRICHLET (1) = Dirichlet constraint
ifm.Enum.BCC_NEUMANN (2) = Neumann constraint
ifm.Enum.BCC_CAUCHY (3) = Cauchy constraint
ifm.Enum.BCC_SINGLE_WELL (4) = Single well constraint
ifm.Enum.BCC_SPECIAL_3RD_BCC (6) = Special 3rd kind flow head B.C.’s constraint

Parameters:: node (int) – Node number
Returns:: The value of boundary mass transport constraint:
Return type:: int

See also

getBccMassValue(node, type_bcc)

IfmGetBccMassValue - Retrieve the value of boundary mass transport constraint

ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint
ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint
ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport)
ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

Parameters:

node (int) – Node number
type_bcc (int) – Constraint flag:

Returns:

The value of boundary mass transport constraint

Return type:

int

Notes

The value is related to the current simulation time Indexing starts with 0.

See also

getBorderNode(border, Node)

Retrieve the node number of a border node.

Parameters:

border (int) – ID of the border
Node (int) – border node local index

Returns:

The node global index

Return type:

int

Examples

Return an integer vector containing all node number which belong to the selected border. The nodes are ordered to be used as a polygon. The orientation is counter-clock wise for exterior border and clock-wise for interor borders.

>>> border_no = 0
>>> bordernodes = [doc.getBorderNode(border_no, N) for N in range(doc.getNumberOfBorderNodes(border_no))]
>>> print(bordernodes)

[0, 2, 3, 7, 14, 21, 18, 22, 23, 15, 11, 9, 6, 4, 1]

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getCurrentLayerNumber()

IfmGetCurrentLayerNumber - Retrieve the current layer number.

Returns:: The current layer number being edited
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getCurrentSliceNumber()

IfmGetCurrentSliceNumber - Retrieve the current number of slices.

Returns:: The current slice number being edited
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getCurrentTimeIncrement()

Retrieve the current time step length

Returns:: The current time step length. Physical unit is [d]
Return type:: float

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getDiagramBudgetMode(selection)

Get the current budget charting mode of the nodal selection identified by index selection. This setting affects the curves displayed in the budget charts.

Parameters:: selection (int or str) – Nodal Selection index or name
Returns:: the current budget mode id
Return type:: int

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

getDiagramContentType(selection)

Get content type id displayed in content charts

IfmGetDiagramContentType() sets the content type of the elemental selection identified by index nSelIndex. This setting affects the curves displayed in the content charts.

Parameters:: nSelIndex (int or str) – Elemental selection index or name
Returns:: the current content type id
Return type:: int

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

getElement(node, Element)

Retrieve the n’th element number of a node

Parameters:

node (int) – Number of the node
Element (int) – Element local index

Returns:

The n’the element global index for a given node

Return type:

int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getElementCentroid(element)

Returns the coordinates of the centroid of an element.

Parameters:: element (int) – ID of the Element
Returns:: Coordinates of the centroid.
Return type:: [float, float, float]

getElementDiameter(element)

Calculate element ‘element’ maximum diameter.

Parameters:: element (int) – Element index
Returns:: the element’s maximum diameter
Return type:: float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getElementNodes(element)

Returns nodal IDs for all adjacent nodes.

Parameters:: element (int) – ID of the Element
Returns:: List of node IDs.
Return type:: list

getElementalContent(content_type, element)

Retrieve the content value of a given element at current time

ifm.Enum.TOTAL_VOLUME (0) = Total volume
ifm.Enum.VOID_VOLUME (1) = Void volume
ifm.Enum.FLUID_CONTENT (2) = Fluid content
ifm.Enum.DILUTED_MASS (3) = Diluted mass (fluid phase)
ifm.Enum.SORBED_MASS (4) = Sorbed mass (solid phase)
ifm.Enum.ENERGY_FLUID (5) = Energy of fluid phase
ifm.Enum.ENERGY_SOLID (6) = Energy of solid phase
ifm.Enum.ENERGY_TOTAL (7) = Total energy content

Parameters:

content_type (int) – Type of content (see above)
element (int) – Element index

Returns:

The content value of a given element for different content types. Physical units depend on the content type: - ifm.Enum.TOTAL_VOLUME [m3] - ifm.Enum.VOID_VOLUME [m3] - ifm.Enum.FLUID_CONTENT [m3] - ifm.Enum.DILUTED_MASS [g] - ifm.Enum.SORBED_MASS [g] - ifm.Enum.ENERGY_FLUID [J] - ifm.Enum.ENERGY_SOLID [J] - ifm.Enum.ENERGY_TOTAL [J]

Return type:

float

See also

getTotalContent, getElementalContent, getTotalContent2, getElementalContent2, integrateNodalQuantitiesOfElement

getElementalContent2(type, element, v_low, v_high)

Retrieve the content value of a given element at current time

ifm.Enum.TOTAL_VOLUME (0) = Total volume
ifm.Enum.VOID_VOLUME (1) = Void volume
ifm.Enum.FLUID_CONTENT (2) = Fluid content
ifm.Enum.DILUTED_MASS (3) = Diluted mass (fluid phase)
ifm.Enum.SORBED_MASS (4) = Sorbed mass (solid phase)
ifm.Enum.ENERGY_FLUID (5) = Energy of fluid phase
ifm.Enum.ENERGY_SOLID (6) = Energy of solid phase
ifm.Enum.ENERGY_TOTAL (7) = Total energy content

Parameters:

type (IfmContentType2) – Type of content (see above: ifm.Enum.TOTAL_VOLUME, ifm.Enum.VOID_VOLUME …)
element (int) – Element index
v_low (float) – <undocumented>
v_high (float) – <undocumented>

Returns:

The content value of a given element for different content types. Physical units depend on the content type: - ifm.Enum.TOTAL_VOLUME [m3] - ifm.Enum.VOID_VOLUME [m3] - ifm.Enum.FLUID_CONTENT [m3] - ifm.Enum.DILUTED_MASS [g] - ifm.Enum.SORBED_MASS [g] - ifm.Enum.ENERGY_FLUID [J] - ifm.Enum.ENERGY_SOLID [J] - ifm.Enum.ENERGY_TOTAL [J]

Return type:

float

See also

getTotalContent, getElementalContent, getTotalContent2, getElementalContent2, integrateNodalQuantitiesOfElement

getElementalExprDistrIdByName(expr_name)

Retrieve the ID of the first elemental expression-based distribution with name identical to the search name.

Parameters:: expr_name (str) – Elemental expression-based distribution name string
Returns:: Expression-based distribution ID, -1 if does not exist
Return type:: int

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getElementalExprDistrName(expr_id)

Retrieve the name of elemental expression-based distribution

Parameters:: expr_id (int) – Elemental expression-based distribution ID (0, … )
Returns:: The name of the elemental expression-based distribution with ID expr_id
Return type:: str

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getElementalExprDistrValue(expr_id, element)

Returns the value of element element in elemental expression-based distribution with id nID

Parameters:

expr_id (int) – Elemental expression-based distribution ID [0, … ]
element (int) – Element index [0 … ne_3d]

Returns:

Value of element element in elemental expression-based distribution nID.

Return type:

float

Notes

Returns 0.0 in case of invalid element ID or invalid elemental expression-based distribution id.

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getElementalRefDistrIdByName(dist_name)

Retrieve the ID of the first elemental reference distribution with name identical to the search name.

Parameters:: dist_name (str) – Elemental reference distribution name string
Returns:: Reference distribution ID.
Return type:: int

Notes

Return -1 if elemental reference distribution doesn’t exist. -To check identity: Compare the number of characters of the _name.

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getElementalRefDistrName(dist_id)

Retrieve the name of elemental reference distribution

Parameters:: dist_id (long) – Elemental reference distribution ID (0, … )
Returns:: The name of the elemental reference distribution with ID rID
Return type:: str

Notes

Return name “invalid” in case of invalid ID. Indexing starts with 0.

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getElementalRefDistrValue(dist_id, element)

Returns the value of element element in elemental reference distribution with id rID

Parameters:

dist_id (int) – Elemental reference distribution ID [0, … ]
element (long) – Element index [0 … ne_3d]

Returns:

Value of element element in elemental reference distribution rID.

Return type:

float

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getElementalRefDistrValues(distr_id, start, count)

Fetch multiple values of a reference distribution addressed by id and range

Parameters:

distr_id (int) – ID of the Reference Distribution
start (int, optional) – first node index to retrieve data
count (int, optional) – number of nodes to retrieve data

Returns:

Value vector

Return type:

[float]

Examples

>>> refd2 = doc.getElementalRefDistrValues(2)
>>> refd4 = doc.getElementalRefDistrValues(4, 100, 50)

getEquationSolvingType()

Retrieve the type of equation solving

ifm.Enum.EQSOLV_ITERAT (0) = iterative equation solving
ifm.Enum.EQSOLV_DIRECT (1) = direct equation solving

Returns:: The equation solving flag
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getExchangeThicknessAtNode3D(node, layer)

Retrieve the exchange thickness at a node and a given layer number for a 3D problem.

Parameters:

node (int) – Node ID
layer (int) – Layer ID

Returns:

The exchange thickness at a node and layer number related to the current time. Physical unit is [m]

Return type:

float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getExtentX()

Retrieve the problem’s extent in X direction

Returns:: The problems’s X extent (single precision). Physical unit is [m].
Return type:: float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getExtentY()

Retrieve the problem’s extent in Y direction

Returns:: The problems’s Y extent (single precision). Physical unit is [m].
Return type:: float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getExtentZ()

Retrieve the problem’s extent in Z direction

Returns:: The problems’s Z extent (single precision). Physical unit is [m]
Return type:: float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getExtents()

Retrieve the problem’s extents in all directions

Returns:: (xmin, xmax, ymin, ymax, zmin, zmax). Physical unit is [m].
Return type:: tuple(float)

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getFemMesh()

Return the ifm.FemMesh object of the current model

Returns:: FemMesh Instance
Return type:: ifm.FemMesh

getFinalSimulationTime()

Retrieve the final simulation time (t >=0.)

Returns:: The final simulation time (t >=0.). Physical unit is [d].
Return type:: float

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getFlowAnisotropy()

Returns the type if anisotropy of a 3D model.

Returns:: The anisotropy type
Return type:: int

getFlowSaturationValueAtGivenHead(node, head)

Retrieve the saturation value at given hydraulic head for an unsaturated flow problem

Parameters:

node (int) – Node index
head (float) – Value of hydraulic head [m] at this node

Returns:

The saturation value at given hydraulic head of a node

Return type:

float

Notes

Physical unit is [1], The value is related to the current simulation time.

See also

getFlowValueOfGroupIdAtCurrentTime(gID)

Retrieve the value of fluid flux for a given group ID at current time

Parameters:: gID (int) – Group ID
Returns:: The fluid flux value of a given group ID at current time. The value is related to the current simulation time Physical unit is [m3/d] Indexing starts with 0.
Return type:: float

See also

getNumberOfValidGroups, getMaximumNumberOfGroups, isNodeInGroup, getFlowValueOfGroupIdAtCurrentTime, getMassValueOfGroupIdAtCurrentTime, getHeatValueOfGroupIdAtCurrentTime

getFlowValueOfObsIdAtCurrentTime(oID)

Retrieve the value of hydraulic head for a given observation point ID at current time

Parameters:: oID (int) – Observation point ID (0, … )
Returns:: The hydraulic head value of a given observation point ID at current time. The value is related to the current simulation time Physical unit is [m].
Return type:: float

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getFracArea(frac_index, frac_type, frac_mode, frac_law)

Retrieve the geometric aperture or area of a fracture element for given type, mode and law

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

The aperture or area for a fracture of type, mode and law. Physical unit is [m] for aperture or [m2] for area

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracElementDiameter(frac_index)

Calculate fracture element ‘frac_index’ maximum diameter.

Parameters:: frac_index (int) – Element number (0 based)
Returns:: the fracture element’s maximum diameter
Return type:: float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracFlowCompressibility(frac_index, frac_type, frac_mode, frac_law)

Retrieve the compressibility of fracture element for given type, mode and law

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

The compressibility coefficient of a fracture of type, mode and law Physical unit is [1/m]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracFlowConductivity(frac_index, frac_type, frac_mode, frac-law)

Retrieve the hydr. conductivity, hydr. aperture or roughness coeff. for given type, mode and law

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

The hydr. conductivity, hydr. aperture or roughness coeff. of a fracture of type, mode and law Physical unit is [m/d] (Darcy), [m] (Hagen-Poiseuielle) or [m0.333/d] (Manning-Strickler)

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracFlowDensityRatio(frac_index, frac_type, frac_mode, frac-law)

Retrieve the density ratio for density-coupled problems of fracture element for given type, mode and law

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

The density ratio of a fracture of type, mode and law Physical unit is [1]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracFlowExpansionCoeff(frac_index, frac_type, frac_mode, frac-law)

Retrieve the volumetric expansion coefficient for thermally density-coupled problems of fracture element for given type, mode and law

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

The expansion coefficient of a fracture of type, mode and law Physical unit is [1/K]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracFlowSinkSource(frac_index, frac_type, frac_mode, frac-law)

Retrieve the sink/source parameter of fracture element for given type, mode and law

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

The sink/source parameter of a fracture of type, mode and law Physical unit is [1/d]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracFlowStorativity(frac_index, frac_type, frac_mode, frac-law)

Retrieve the storativity of fracture element for given type, mode and law

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

The storativity coefficient of a fracture of type, mode and law Physical unit is [1]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracFlowTransferIn(nFracElement, FracType, FracMode, FracLaw)

Get the Out-Transfer-Rate Parameter of the selected Discrete Feature Element.

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

In-Transfer Rate

Return type:

float

getFracFlowTransferOut(nFracElement, FracType, FracMode, FracLaw)

Get the In-Transfer-Rate Parameter of the selected Discrete Feature Element

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Out-Transfer Rate

Return type:

float

getFracHeatFluidCapacity(nFracElement, FracType, FracMode, FracLaw)

Retrieve the volumetric heat capacity of fluid for a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Volumetric heat capacity of fluid. Physical unit is [J/m3/K].

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracHeatFluidConductivity(frac_index, frac_type, frac_mode, frac_law)

Retrieve the heat conductivity of fluid for a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the heat conductivity of fluid. Physical unit is [J/m/d/K].

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracHeatFluidSinkSource(frac_index, frac_type, frac_mode, frac_law)

Retrieve the heat source/sink of fluid for a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the heat source/sink of fluid of a fracture. Physical unit is [J/m3/d].

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracHeatLongDispersivity(frac_index, frac_type, frac_mode, frac_law)

Retrieve the longitudinal dispersivity for a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the longitudinal dispersivity for a fracture. Physical unit is [m].

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracHeatPorosity(frac_index, frac_type, frac_mode, frac_law)

Retrieve the kinematic porosity applied to a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the kinematic porosity applied to a heat transport problem of a fracture of type, mode and law.. Physical unit is [1]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracHeatSolidCapacity(frac_index, frac_type, frac_mode, frac_law)

Retrieve the volumetric heat capacity of solid for a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the volumetric heat capacity of solid for a heat transport problem of a fracture of type, mode and law. Physical unit is [J/m3/K]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracHeatSolidConductivity(frac_index, frac_type, frac_mode, frac_law)

Retrieve the heat conductivity of solid for a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the heat conductivity of solid for a heat transport problem of a fracture of type, mode and law. Physical unit is [J/m/d/K]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracHeatSolidSinkSource(frac_index, frac_type, frac_mode, frac_law)

Retrieve the heat source/sink of solid for a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the heat source/sink of solid for a heat transport problem. Physical unit is [J/m3/d]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracHeatTransDispersivity(frac_index, frac_type, frac_mode, frac_law)

Retrieve the transverse dispersivity for a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the transverse dispersivity for a heat transport problem of a fracture of type, mode and law. Physical unit is [m]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracHeatTransferIn(frac_index, frac_type, frac_mode, frac_law)

Retrieve the transfer rate for influx of a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the transfer rate for influx of a heat transport problem of a fracture of type, mode and law. Physical unit is [J/m2/d/K]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracHeatTransferOut(frac_index, frac_type, frac_mode, frac_law)

Retrieve the transfer rate for outflux of a heat transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the transfer rate for outflux of a heat transport problem of a fracture of type, mode and law. Physical unit is [J/m2/d/K]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracLaw(frac_index, frac_type, frac_mode)

Returns the fluid flow law of a fracture element for given type, mode and law:

ifm.Enum.ALL_FRAC_LAWS = -1 All fracture flow laws
ifm.Enum.DARCY_LAW = 0 Darcy flow equation
ifm.Enum.HP_LAW = 1 Hagen-Poiseuille flow equation
ifm.Enum.MANNING_LAW = 2 Manning-Strickler flow equation

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode

Returns:

Law identifier of the DFE.

Return type:

int

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracMassDecayRate(frac_index, frac_type, frac_mode, frac_law)

Retrieve the decay rate applied to a mass transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the decay rate applied to a mass transport problem of a fracture of type, mode and law. Physical unit is [1/d]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracMassDiffusion(frac_index, frac_type, frac_mode, frac_law)

Retrieve the molecular diffusion applied to a mass transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the molecular diffusion applied to a mass transport problem of a fracture of type, mode and law. Physical unit is [m2/d]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracMassLongDispersivity(frac_index, frac_type, frac_mode, frac_law)

Retrieve the longitudinal dispersivity applied to a mass transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the longitudinal dispersivity applied to a mass transport problem of a fracture of type, mode and law. Physical unit is [m]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracMassPorosity(frac_index, frac_type, frac_mode, frac_law)

Retrieve the kinematic porosity applied to a mass transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the kinematic porosity applied to a mass transport problem of a fracture of type, mode and law. Physical unit is [1]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracMassSinkSource(frac_index, frac_type, frac_mode, frac_law)

Retrieve the sink/source applied to a mass transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the sink/source applied to a mass transport problem of a fracture of type, mode and law. Physical unit is [g/m3/d]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracMassSorptionCoeff(frac_index, frac_type, frac_mode, frac_law)

Retrieve the sorption coefficient applied to a mass transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the sorption coefficient applied to a mass transport problem of a fracture of type, mode and law. Physical unit is [1]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracMassTransDispersivity(frac_index, frac_type, frac_mode, frac_law)

Retrieve the transverse dispersivity applied to a mass transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the transverse dispersivity applied to a mass transport problem of a fracture of type, mode and law. Physical unit is [m]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracMassTransferIn(frac_index, frac_type, frac_mode, frac_law)

Retrieve the transfer rate for influx of a mass transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the transfer rate for influx of a mass transport problem of a fracture of type, mode and law. Physical unit is [m/d]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getFracMassTransferOut(frac_index, frac_type, frac_mode, frac_law)

Retrieve the transfer rate for outflux of a mass transport problem for given type, mode and law of fractures

Parameters:

frac_index (int) – Fracture element number
frac_type ({ifm.Enum.ALL_FRAC_TYPES, ifm.Enum.FRAC_1D, ifm.Enum.FRAC_2D_TRI, FRAC_2D_QUA}) – Fracture element type
frac_mode ({ifm.Enum.ALL_FRAC_MODES, ifm.Enum.FRAC_H, ifm.Enum.FRAC_V, ifm.Enum.FRAC_A}) – Fracture element selection mode
frac_law ({ifm.Enum.ALL_FRAC_LAWS, ifm.Enum.DARCY_LAW, ifm.Enum.HP_LAW, ifm.Enum.MANNING_LAW}) – Fracture element flow law

Returns:

Retrieve the transfer rate for influx of a mass transport problem of a fracture of type, mode and law. Physical unit is [m/d]

Return type:

float

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getGeoCoordinateSystem(int)

Get WGEO coordinate system definition FEFLOW can hold multiple coordinate system definition identified by a unique CS id:

Ifm.Enum.CS_WGEO : WGEO coordinate system definition
Ifm.Enum.CS_AUTHSTR: Authority string[i.e., ‘epsg:4326’]
Ifm.Enum.CS_CRSWKT : CRS WKT string
Ifm.Enum.CS_PROJ : PROJ4 string
Ifm.Enum.CS_JSON : JSON string with PROJ parameters
Ifm.Enum.CS_PRJFILE : Projection file (ESRI compatible)

All coordinate system definitions are UTF-8 encoded and allow therefore the use of localized characters.

Parameters:: cs ({Ifm.Enum.CS_WGEO, Ifm.Enum.CS_AUTHSTR, Ifm.Enum.CS_CRSWKT, Ifm.Enum.CS_PROJ, Ifm.Enum.CS_JSON, Ifm.Enum.CS_PRJFILE}) – Type of coordinate system description
Returns:: UTF-8 encoded coordinate system definition
Return type:: str

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getGravityDirection()

Retrieve the direction of gravity

ifm.Enum.GRAVITY_DIM_X (0) = along the x-axis
ifm.Enum.GRAVITY_DIM_Y (1) = along the y-axis
ifm.Enum.GRAVITY_DIM_Z (2) = along the z-axis (only in three dimensions)

and the ‘gfactor’

which is positive (+1.0) if gravity acts in negative direction and
which is negative (-1.0) if gravity acts in positive direction of axes

Returns:: The index of direction of gravity acting along a principal coordinate direction
Return type:: int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getHeatValueOfGroupIdAtCurrentTime(gID)

Retrieve the value of heat flux for a given group ID at current time

Parameters:: gID (int) – Group ID
Returns:: The heat flux value of a given group ID at current time The value is related to the current simulation time. Physical unit is [J/d].
Return type:: float

See also

getNumberOfValidGroups, getMaximumNumberOfGroups, isNodeInGroup, getFlowValueOfGroupIdAtCurrentTime, getMassValueOfGroupIdAtCurrentTime, getHeatValueOfGroupIdAtCurrentTime

getHeatValueOfObsIdAtCurrentTime(oID)

Retrieve the value of temperature (heat) for a given observation point ID at current time

Parameters:: oID (int) – Observation point ID (0, … )
Returns:: The temperature value of a given observation point ID at current time
Return type:: float

Notes

The value is related to the current simulation time Physical unit is [deg C] Indexing starts with 0.

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getHistoryValues(history_id, subkind)

Fetch history times and values into pre-allocated arrays.

Parameters:

history_id (int) – History parameter, e.g., head, local concentration, etc.
subkind (int) – Subkind of parameter, e.g., pressure (1), saturation(2), or species number

Returns:

Tuple of list of time values[nTimes], list of history values [nTimes][nHist]Times, list of curve labels [nHist]

Return type:

(list, list, list)

See also

getInitialSimulationTime()

Retrieve the initial simulation time (t >=0.)

Returns:: The initial simulation time (t >=0.). Physical unit is [d].
Return type:: float

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getInitialTimeIncrement()

Retrieve the initial time step length

Returns:: The initial time step length. Physical unit is [d]
Return type:: float

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getIterativeNonSymEquationSolverType()

Retrieve the type of iterative nonsymmetric equation solver

ifm.Enum.ITERNONSYMEQS_ORTHO (0) = ORTHOMIN method
ifm.Enum.ITERNONSYMEQS_GMRES (1) = GMRES method
ifm.Enum.ITERNONSYMEQS_CGS (2) = CGS method
ifm.Enum.ITERNONSYMEQS_BICGSTAB (3) = BICGSTAB method
ifm.Enum.ITERNONSYMEQS_BICGSTABP (4) = BICGSTABP method
ifm.Enum.ITERNONSYMEQS_AMG (5) = AMG method

Returns:: The iterative nonsymmetric equation solver flag
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getIterativeSymEquationSolverType()

Retrieve the type of iterative symmetric equation solver

ifm.Enum.ITERSYMEQS_PCG (0) = conjugate gradient method
ifm.Enum.ITERSYMEQS_AMG (1) = algebraic multigrid method

Returns:: The iterative symmetric equation solver flag
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getLoadVersion()

Retrieve module version found in FEM file

IfmGetLoadVersion() returns the version of the IFM module that has been created this document. Newer modules should be always able to read earlier created files and attempt to read only parts supported by this version.

Returns:: Version of the document creating IFM module.
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getLookupTable()

Returns the models Lookup Table as an object.

Returns:: The models Lookup Table
Return type:: ifm.LookupTable

See also

ifm.LookupTable

Examples

>>> lookup = doc.getLookupTable()
>>> print(lookup.getMaterials())
>>> {'Sand': 1, 'Clay': 2, 'Bedrock': 3}

getMassMatricesFlag()

Retrieve the flag of consistent versus lumped mass matrices

ifm.Enum.CONSISTENT_MM (0) = consistent mass matrix
ifm.Enum.LUMPED_MM (1) = lumped mass matrix

Returns:: The mass matrix flag
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getMassValueOfGroupIdAtCurrentTime(gID)

Retrieve the value of mass flux for a given group ID at current time

Parameters:: gID (int) – Group ID
Returns:: The mass flux value of a given group ID at current time. The value is related to the current simulation time. Physical unit is [g/d].
Return type:: float

See also

getNumberOfValidGroups, getMaximumNumberOfGroups, isNodeInGroup, getFlowValueOfGroupIdAtCurrentTime, getMassValueOfGroupIdAtCurrentTime, getHeatValueOfGroupIdAtCurrentTime

getMassValueOfObsIdAtCurrentTime(oID)

Retrieve the value of mass (concentration) for a given observation point ID at current time

Parameters:: oID (int) – Observation point ID (0, … )
Returns:: The concentration value of a given observation point ID at current time The value is related to the current simulation time Physical unit is [mg/l] Indexing starts with 0.
Return type:: float

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getMatAnisotropyAngle2D(element)

Retrieve the anisotropic rotation (Euler) angle for a 2D problem

Parameters:: element (int) – Element number
Returns:: The anisotropic rotation (Euler) angle for a 2D problem. Physical unit is [deg] Indexing starts with 0.
Return type:: float

See also

getMatAnisotropyAnglePhi(element)

Retrieve the anisotropic rotation (Euler) phi angle for a 3D problem

Parameters:: element (int) – Element number
Returns:: The anisotropic rotation (Euler) phi angle for a 3D problem. Physical unit is [deg] Indexing starts with 0.
Return type:: float

See also

getMatAnisotropyAnglePsi(element)

Retrieve the anisotropic rotation (Euler) psi angle for a 3D problem

Parameters:: element (int) – Element number
Returns:: The anisotropic rotation (Euler) psi angle for a 3D problem. Physical unit is [deg] Indexing starts with 0.
Return type:: float

See also

getMatAnisotropyAngleTheta(element)

Retrieve the anisotropic rotation (Euler) theta angle for a 3D problem

Parameters:: element (int) – Element number
Returns:: The anisotropic rotation (Euler) theta angle for a 3D problem. Physical unit is [deg] Indexing starts with 0.
Return type:: float

See also

getMatAnisotropyFactor2D(element)

Retrieve the anisotropy factor for a 2D problem

Parameters:: element (int) – Element number
Returns:: The anisotropy factor for a 2D problem. Physical unit is [1] Indexing starts with 0.
Return type:: float

See also

getMatBottom2D(element)

Retrieve the elevation of aquifer bottom geometry for a 2D problem

Parameters:: element (int) – Element number
Returns:: The elevation of aquifer bottom geometry for a 2D problem. Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatConductivityTensor3D(element)

Get the conductivity anisotropy tensor of a finite element

Parameters:: element (int) – Element number (first element = 0)
Returns:: the 3x3 conductivity tensor matrix of an element. Indexing starts with 0.
Return type:: [[float]]

See also

getMatConductivityValue2D(element)

Retrieve the hydraulic conductivity value for a 2D flow problem

Parameters:: element (int) – Element number
Returns:: The value of the hydraulic conductivity value for a 2D flow problem. Physical unit is [m2/d] for horizontal confined problems (it means the transmissivity) or [m/d] for horizontal unconfined, vertical or axisymmetric problems, Indexing starts with 0.
Return type:: float

See also

getMatElementActive(element)

Retrieve active state of a finite element

Parameters:: element (int) – Element number
Returns:: 1 if the selected element is active otherwise 0
Return type:: int

See also

getMatFlowCompressibility(element)

Retrieve the compressibility for a transient flow problem

Parameters:: element (int) – Element number
Returns:: The compressibility for a transient flow problem. Physical unit is [1/m] for 3D or 2D vertical/axisymmetric and unconfined, or [1] if 2D horizontal and confined Indexing starts with 0.
Return type:: float

See also

getMatFlowDensityRatio(element)

Retrieve the density ratio for density-coupled problems

Parameters:: element (int) – Element number
Returns:: The density ratio for density-coupled problems. Physical unit is [1] Indexing starts with 0.
Return type:: float

See also

getMatFlowExpansionCoeff(element)

Retrieve the volumetric expansion coefficient for thermally density-coupled problems

Parameters:: element (int) – Element number
Returns:: The volumetric expansion coefficient for thermally density-coupled problems. Physical unit is [1/K] Indexing starts with 0.
Return type:: float

See also

getMatFlowRechargeValue(element)

Retrieve the recharge (sink/source) value for a flow problem

Parameters:: element (int) – Element number
Returns:: The recharge (sink/source) value for a flow problem. Physical unit is [m/d] Indexing starts with 0.
Return type:: float

See also

getMatFlowSinkSource(element)

Retrieve the sink/source parameter for a flow problem

Parameters:: element (int) – Element number
Returns:: The sink/source parameter for a flow problem. Physical unit is [1/d] for 3D or 2D vertical/axisymmetric, or [m/d] if 2D horizontal Indexing starts with 0.
Return type:: float

See also

getMatFlowStorativity(element)

Retrieve the storativity parameter for flow

Parameters:: element (int) – Element number
Returns:: The storativity parameter for flow Physical unit is [1] Indexing starts with 0.
Return type:: float

See also

getMatFlowTransferIn(element)

Retrieve the transfer rate for inflow of a flow problem

Parameters:: element (int) – Element number
Returns:: The transfer rate for inflow of a flow problem Physical unit is [1/d] for 3D or 2D vertical/axisymmetric, or [m/d] if 2D horizontal, except unconfined 2D without integral BC’s where [1/d] Indexing starts with 0.
Return type:: float

See also

getMatFlowTransferOut(element)

Retrieve the transfer rate for inflow of a flow problem

Parameters:: element (int) – Element number
Returns:: The transfer rate for inflow of a flow problem Physical unit is [1/d] for 3D or 2D vertical/axisymmetric, or [m/d] if 2D horizontal, except unconfined 2D without integral BC’s where [1/d] Indexing starts with 0.
Return type:: float

See also

getMatHeatAnglePitch(element)

Retrieve the anisotropic rotation pitch angle for a 3D problem

Parameters:: element (int) – Element number
Returns:: The anisotropic rotation pitch angle for a 3D problem Physical unit is [deg] Indexing starts with 0.
Return type:: float

See also

getMatHeatAngleYaw(element)

Retrieve the anisotropic rotation yaw angle for a 3D problem

Parameters:: element (int) – Element number
Returns:: The anisotropic rotation yaw angle for a 3D problem Physical unit is [deg] Indexing starts with 0.
Return type:: float

See also

getMatHeatAquiferThickness(element)

Retrieve the aquifer thickness applied to a 2D heat transport problem

Parameters:: element (int) – Element number
Returns:: The aquifer thickness applied to a 2D heat transport problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatHeatFluidCapacity(element)

Retrieve the volumetric heat capacity of fluid for a heat transport problem

Parameters:: element (int) – Element number
Returns:: The volumetric heat capacity of fluid for a heat transport problem Physical unit is [J/m3/K] Indexing starts with 0.
Return type:: float

See also

getMatHeatFluidConductivity(element)

Retrieve the heat conductivity of fluid for a heat transport problem

Parameters:: element (int) – Element number
Returns:: The heat conductivity of fluid for a heat transport problem Physical unit is [J/m/d/K] Indexing starts with 0.
Return type:: float

See also

getMatHeatFluidSinkSource(element)

Retrieve the heat source/sink of fluid for a heat transport problem

Parameters:: element (int) – Element number
Returns:: The heat source/sink of fluid for a heat transport problem Physical unit is [J/m3/d] for 3D and 2D vertical and axisymmetric or [J/m2/d] for 2D horizontal Indexing starts with 0.
Return type:: float

See also

getMatHeatMaxLongDispersivity(element)

Retrieve the maximal longitudinal dispersivity applied to a heat transport problem

Parameters:: element (int) – Element number
Returns:: The maximal longitudinal dispersivity applied to a heat transport problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatHeatMaxTransDispersivity(element)

Retrieve the maximal transverse dispersivity applied to a heat transport problem

Parameters:: element (int) – Element number
Returns:: The maximal transverse dispersivity applied to a heat transport problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatHeatMinLongDispersivity(element)

Retrieve the minimal longitudinal dispersivity applied to a heat transport problem

Parameters:: element (int) – Element number
Returns:: The minimal longitudinal dispersivity applied to a heat transport problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatHeatMinTransDispersivity(element)

Retrieve the minimal transverse dispersivity applied to a heat transport problem

Parameters:: element (int) – Element number
Returns:: The minimal transverse dispersivity applied to a heat transport problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatHeatPorosity(element)

Retrieve the kinematic porosity applied to a heat transport problem

Parameters:: element (int) – Element number
Returns:: The kinematic porosity applied to a heat transport problem Physical unit is [1] Indexing starts with 0.
Return type:: float

See also

getMatHeatSolidCapacity(element)

Retrieve the volumetric heat capacity of solid for a heat transport problem

Parameters:: element (int) – Element number
Returns:: The volumetric heat capacity of solid for a heat transport problem Physical unit is [J/m3/K] Indexing starts with 0.
Return type:: float

See also

getMatHeatSolidConductivity(element)

Retrieve the heat conductivity of solid for a heat transport problem

Parameters:: element (int) – Element number
Returns:: The heat conductivity of solid for a heat transport problem Physical unit is [J/m/d/K] Indexing starts with 0.
Return type:: float

See also

getMatHeatSolidSinkSource(element)

Retrieve the heat source/sink of solid for a heat transport problem

Parameters:: element (int) – Element number
Returns:: The heat source/sink of solid for a heat transport problem Physical unit is [J/m3/d] for 3D and 2D vertical and axisymmetric or [J/m2/d] for 2D horizontal Indexing starts with 0.
Return type:: float

See also

getMatHeatTransferIn(element)

Retrieve the transfer rate for influx of a heat transport problem

Parameters:: element (int) – Element number
Returns:: The transfer rate for influx of a heat transport problem Physical unit is [J/m2/d/K] for 3D or 2D vertical/ axisymmetric, or [J/m2/d/K] if 2D horizontal, except unconfined 2D for integral BC’s where [J/m/d/K] Indexing starts with 0.
Return type:: float

See also

getMatHeatTransferOut(element)

Retrieve the transfer rate for outflux of a heat transport problem

Parameters:: element (int) – Element number
Returns:: The transfer rate for outflux of a heat transport problem Physical unit is [J/m2/d/K] for 3D or 2D vertical/ axisymmetric, or [J/m2/d/K] if 2D horizontal, except unconfined 2D for integral BC’s where [J/m/d/K] Indexing starts with 0.
Return type:: float

See also

getMatMassAnglePitch(element)

Retrieve the anisotropic rotation pitch angle for a 3D problem

Parameters:: element (int) – Element number
Returns:: The anisotropic rotation pitch angle for a 3D problem Physical unit is [deg] Indexing starts with 0.
Return type:: float

See also

getMatMassAngleYaw(element)

Retrieve the anisotropic rotation yaw angle for a 3D problem

Parameters:: element (int) – Element number
Returns:: The anisotropic rotation yaw angle for a 3D problem Physical unit is [deg] Indexing starts with 0.
Return type:: float

See also

getMatMassAquiferThickness(element)

Retrieve the aquifer thickness applied to a 2D mass transport problem

Parameters:: element (int) – Element number
Returns:: The aquifer thickness applied to a 2D mass transport problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatMassDecayRate(element)

Retrieve the decay rate for a mass transport problem

Parameters:: element (int) – Element number
Returns:: The decay rate for a mass transport problem Physical units are [1/d] - FIRST_ORDER_DECAY [mg/l/d] - MICHAELIS_MENTEN Indexing starts with 0.
Return type:: float

See also

getMatMassDecayRate2(element)

Retrieve the decay rate 2 for a mass transport problem

Parameters:: element (int) – Element number
Returns:: The decay rate for a mass transport problem Physical units are [mg/l] - MICHAELIS_MENTEN Indexing starts with 0.
Return type:: float

See also

getMatMassDiffusion(element)

Retrieve the molecular diffusion of a mass transport problem

Parameters:: element (int) – Element number
Returns:: The molecular diffusion of a mass transport problem Physical unit is [m2/d] Indexing starts with 0.
Return type:: float

See also

getMatMassLongDispersivity(element)

Get the longitudinal Dispersivity of an element

Parameters:: element (int) – element index
Returns:: The longitudianl Dispersivity of an element. Physical unit is [m]
Return type:: float

getMatMassMaxLongDispersivity(element)

Retrieve the maximal longitudinal dispersivity applied to a mass transport problem

Parameters:: element (int) – Element number
Returns:: The maximal longitudinal dispersivity applied to a mass transport problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatMassMaxTransDispersivity(element)

Retrieve the maximal transverse dispersivity applied to a mass transport problem

Parameters:: element (int) – Element number
Returns:: The maximal transverse dispersivity applied to a mass transport problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatMassMinLongDispersivity(element)

Retrieve the minimal longitudinal dispersivity applied to a mass transport problem

Parameters:: element (int) – Element number
Returns:: The minimal longitudinal dispersivity applied to a mass transport problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatMassMinTransDispersivity(element)

Retrieve the minimal transverse dispersivity applied to a mass transport problem

Parameters:: element (int) – Element number
Returns:: The minimal transverse dispersivity applied to a mass transport problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatMassPorosity(element)

Retrieve the kinematic porosity applied to a mass transport problem

Parameters:: element (int) – Element number
Returns:: The kinematic porosity applied to a mass transport problem Physical unit is [1] Indexing starts with 0.
Return type:: float

See also

getMatMassSinkSource(element)

Retrieve the sink/source for a mass transport problem

Parameters:: element (int) – Element number
Returns:: The sink/source for a mass transport problem Physical unit is [g/m3/d] for 3D or 2D vertical/ axisymmetric, or [g/m2/d] if 2D horizontal Indexing starts with 0.
Return type:: float

See also

getMatMassSorptionCoeff1(element)

Retrieve the sorption coefficient applied to a mass transport problem

Parameters:: element (int) – Element number
Returns:: The sorption coefficient applied to a mass transport problem: Henry sorption - the Henry coefficient, Freundlich or Langmuir sorption - the numerator (b1, k1) sorption coefficient Physical units are [1] - HENRY_ISOTHERM [(mg/l)^(1-b2)] - FREUNDLICH_ISOTHERM [1] - LANGMUIR_ISOTHERM Indexing starts with 0.
Return type:: float

See also

getMatMassSorptionCoeff2(element)

Retrieve the sorption coefficient applied to a mass transport problem

Parameters:: element (int) – Element number
Returns:: The sorption coefficient applied to a mass transport problem: Freundlich or Langmuir sorption - the denominator (b2, k2) sorption coefficient, Physical units are [1] for FREUNDLICH_ISOTHERM and [l/mg] for LANGMUIR_ISOTHERM
Return type:: float

See also

getMatMassTransDispersivity(element)

Get the Transversal Dispersivity of an element

Parameters:: element (int) – element index
Returns:: Transversal Dispersivity [m]
Return type:: float

getMatMassTransferIn(element)

Retrieve the transfer rate for influx of a mass transport problem

Parameters:: element (int) – Element number
Returns:: The transfer rate for influx of a mass transport problem Physical unit is [m/d] for 3D or 2D vertical/ axisymmetric, or [m/d] if 2D horizontal, except unconfined 2D for integral BC’s where [m2/d] Indexing starts with 0.
Return type:: float

See also

getMatMassTransferOut(element)

Retrieve the transfer rate for outflux of a mass transport problem

Parameters:: element (int) – Element number
Returns:: The transfer rate for outflux of a mass transport problem Physical unit is [m/d] for 3D or 2D vertical/ axisymmetric, or [m/d] if 2D horizontal, except unconfined 2D for integral BC’s where [m2/d] Indexing starts with 0.
Return type:: float

See also

getMatTops2D(element)

Retrieve the elevation of aquifer top geometry for a 2D problem

Parameters:: element (int) – Element number
Returns:: The elevation of aquifer top geometry for a 2D problem Physical unit is [m] Indexing starts with 0.
Return type:: float

See also

getMatUnsatAirEntryPressureHead(element)

Retrieve the air pressure head for unsaturated problems

Parameters:

element (int) – Element number

Returns:

The air pressure head value for unsaturated problems

Physical unit are - [m] - IfmPM_VAN_GENUCHTEN - not available - IfmPM_BROOKS_COREY - [m] - IfmPM_HAVERKAMP - [m] - IfmPM_EXPONENTIAL - [m] - IfmPM_LINEAR - [m] - IfmPM_VG_MODIFIED

Indexing starts with 0.

Return type:

int

See also

getMatUnsatFittingCoefficient(element)

Retrieve the fitting coefficient for unsaturated problems

Parameters:

element (int) – Element number

Returns:

The fitting coefficient value for unsaturated problems

Physical unit are
[1/m] - IfmPM_VAN_GENUCHTEN
[1/m] - IfmPM_BROOKS_COREY
[m] - IfmPM_HAVERKAMP
not available - IfmPM_EXPONENTIAL
[m] - IfmPM_LINEAR
[1/m] - IfmPM_VG_MODIFIED

Return type:

float

See also

getMatUnsatFittingCoefficientDryingCurve(element)

Retrieve the fitting coefficient for the hysteretic drying curve for unsaturated problems

Parameters:

element (int) – Element number

Returns:

The fitting coefficient value for the hysteretic drying curve

[1/m] - IfmPM_VAN_GENUCHTEN [1/m] - IfmPM_BROOKS_COREY [m] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL [m] - IfmPM_LINEAR [1/m] - IfmPM_VG_MODIFIED Indexing starts with 0.

Return type:

float

See also

getMatUnsatFittingExponent(element)

Retrieve the fitting exponent for unsaturated problems

Parameters:

element (int) – Element number

Returns:

The fitting exponent value for unsaturated problems

[1] - IfmPM_VAN_GENUCHTEN [1] - IfmPM_BROOKS_COREY [1] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED Indexing starts with 0.

Return type:

float

See also

getMatUnsatFittingExponent2(element)

Retrieve the fitting exponent 2 for unsaturated problem

Parameters:

element (int) – Element number

Returns:

The fitting exponent 2 value for unsaturated problems

Physical unit are not available - IfmPM_VAN_GENUCHTEN [1] - IfmPM_BROOKS_COREY [m] - IfmPM_HAVERKAMP [1/m] - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED Indexing starts with 0.

Return type:

float

See also

getMatUnsatFittingExponent2DryingCurve(element)

Retrieve the fitting exponent for the hysteretic drying curve for unsaturated problems

Parameters:

element (int) – Element number

Returns:

The fitting exponent 2 value for the hysteretic drying curve

Physical unit are [1] - IfmPM_VAN_GENUCHTEN [1] - IfmPM_BROOKS_COREY [1] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED Indexing starts with 0.

Return type:

float

See also

getMatUnsatFittingExponent3(element)

Retrieve the fitting exponent 3 for unsaturated problems

Parameters:

element (int) – Element number

Returns:

The fitting exponent 3 value for unsaturated problems

Physical unit are not available - IfmPM_VAN_GENUCHTEN not available - IfmPM_BROOKS_COREY [1] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED Indexing starts with 0.

Return type:

float

See also

getMatUnsatFittingExponent3DryingCurve(element)

Retrieve the fitting exponent for the hysteretic drying curve for unsaturated problems

Parameters:: element (int) – Element number
Returns:: The fitting exponent 3 value for the hysteretic drying curve Physical unit are [1]
Return type:: float

See also

getMatUnsatFittingExponentDryingCurve(element)

Retrieve the fitting exponent for the hysteretic drying curve for unsaturated problems

Parameters:

element (int) – Element number

Returns:

The fitting exponent value for the hysteretic drying curve

Physical unit are [1] - IfmPM_VAN_GENUCHTEN [1] - IfmPM_BROOKS_COREY [1] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED Indexing starts with 0.

Return type:

float

See also

getMatUnsatMaximumSaturation(element)

Retrieve the maximum saturation for unsaturated problems

Parameters:: element (int) – Element number
Returns:: The maximum saturation value for unsaturated problems Physical unit is [1] Indexing starts with 0.
Return type:: float

See also

getMatUnsatModelType(element)

Get the unsaturated Model Type of an Element

Parameters:: element (int) – element index
Returns:: unsaturated model type
Return type:: int

getMatUnsatPorosity(element)

Retrieve the porosity value for unsaturated problems

Parameters:: element (int) – Element number
Returns:: The porosity value for unsaturated problems Physical unit is [1] Indexing starts with 0.
Return type:: float

See also

getMatUnsatResidualSaturation(element)

Retrieve the residual saturation for unsaturated problems

Parameters:: element (int) – Element number
Returns:: The residual saturation value for unsaturated problems Physical unit is [1] Indexing starts with 0.
Return type:: float

See also

getMatXConductivityValue3D(element)

Retrieve the hydraulic conductivity value in the x-direction for a 3D flow problem

Parameters:: element (int) – Element number
Returns:: The value of the hydraulic conductivity value in the x-direction for a 3D flow problem Physical unit is [m/d] Indexing starts with 0.
Return type:: float

See also

getMatYConductivityValue3D(element)

Retrieve the hydraulic conductivity value in the x-direction for a 3D flow problem

Parameters:: element (int) – Element number
Returns:: The value of the hydraulic conductivity value in the y-direction for a 3D flow problem Physical unit is [m/d] Indexing starts with 0.
Return type:: float

See also

getMatZConductivityValue3D(element)

Retrieve the hydraulic conductivity value in the z-direction for a 3D flow problem

Parameters:: element (int) – Element number
Returns:: The value of the hydraulic conductivity value in the z-direction for a 3D flow problem Physical unit is [m/d] Indexing starts with 0.
Return type:: float

See also

getMaximumNumberOfGroups()

IfmGetMaximumNumberOfGroups - Retrieve the maximum number of groups

Returns:: The maximum number of groups occurred if > 0 a number of groups exist if == 0 there are no groups
Return type:: int

See also

getNumberOfValidGroups, getMaximumNumberOfGroups, isNodeInGroup, getFlowValueOfGroupIdAtCurrentTime, getMassValueOfGroupIdAtCurrentTime, getHeatValueOfGroupIdAtCurrentTime

getMeshType()

GetMeshType()

Retrieve the type of meshing

Returns:: The mesh flag ifm.Enum.MSH_TRIA (0) = triangular element mesh ifm.Enum.MSH_QUAD (1) = quadrilateral element mesh
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getMetaData()

Retrieve the System Meta Information saved in the FEFLOW model (Problem Settings).

Returns:: System Meta Information
Return type:: string

See also

getUserMetaData, parseUserMetaData, setUserMetaData

getMoistureContentValueOfObsIdAtCurrentTime(oID)

Retrieve the value of moisture content for a given observation point ID at current time

Parameters:: oID (int) – Observation point ID (0, … )
Returns:: The moisture content value of a given observation point ID at current time The value is related to the current simulation time Physical unit is [1] Indexing starts with 0.
Return type:: float

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getMultiLayerWellAttrTSID(mlw_index, mlw_attrib)

Fetch time-series ID of a transient multilayer well attribute

Parameters:

mlw_index (int) – Node independent ID (index) of the multilayer well
mlw_attrib (Ifm.Enum.MLW_ATTR) – Multi-layer well attribute

Returns:

the time-series ID of a transient attribute of a multilayer well

Return type:

int

See also

getMultiLayerWellAttrValue(mlw_index, mlw_attrib)

Fetch constant multilayer well attribute value

Parameters:

mlw_index (int) – index of multilayer well
mlw_attrib (Ifm.Enum.MLW_ATTR) – Multi-layer well attribute

Returns:

the constant attribute value of a multilayer well For actual units see definition of IfmMLW_ATTR

Return type:

float

See also

getMultiLayerWellBottomNode(mlw_index)

Retrieve current (dynamic) bottom node of a multilayer well

Parameters:: mlw_index (int) – Node independent ID (index) of the multilayer well
Returns:: (0 based) bottom node number of a multilayer well defined by its index
Return type:: int

See also

getMultiLayerWellTopNode(mlw_index)

Retrieve current (dynamic) top node of multilayer well

Parameters:: mlw_index (int) – Node independent ID (index) of the multilayer well
Returns:: (0 based) top node number of a multilayer well defined by its index
Return type:: int

See also

getMultiSpeciesId()

GetMultiSpeciesId())

Retrieve the Id of current chemical species equations

Returns:: The Id of chemical species equations for multispecies mass transport
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNextElement2D(element, rc_bounds)

Find the next element in a given boundary IfmGetNextElement2D() allows to iterate over all elements in a given rectangular area. To search for the first element inside the area, element should be set to -1.

Parameters:

element (int) – Start element number (initially: -1)
rc_bounds ([double, double, double, double]) – Boundary of searching

Returns:

The index of the next element inside the boundary or -1 if no further element can be found.

Return type:

int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getNextNode2D()

getNextNode2D(node, rc_bounds)

Find the next node in a given boundary IfmGetNextNode2D() allows to iterate over all nodes in a given rectangular area. To search for the first node inside the area, node should be set to -1.

Parameters:

node (int) – Start node number (initially: -1)
rc_bounds ([double, double, double, double]) – Boundary to search within

Returns:

The index of the next node inside the boundary or -1 if no further node can be found.

Return type:

int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getNodalArrayOfFractureElement(frac_id)

Retrieve the number of nodes per fracture element and the nodal incidence array of the fracture element

Nodal data are stored in the IfmFracNodes structure

struct { int nbn; Number of nodes per fracture element (max 4) int nop[4]; Nodal incidence }

Indexing starts with 0.

Parameters:: frac_id (int) – Fracture element number
Returns:: Nodal Array of fracture flement
Return type:: object

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getNodalExprDistrIdByName(expr_name)

Retrieve the ID of the first nodal expression-based distribution with name identical to the search name.

Parameters:: expr_name (str) – Nodal expression-based distribution name string
Returns:: Expression-based distribution ID. - Return -1 if nodal expression-based distribution doesn’t exist. - To check identity: Compare the number of characters of the name.
Return type:: int

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNodalExprDistrName(expr_id)

Retrieve the name of nodal expression-based distribution

Parameters:

expr_id (int) – Nodal expression-based distribution ID (0, … )

Returns:

The name of the nodal expression-based distribution with ID nID
Returns NULL in case of invalid ID.

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNodalExprDistrValue(expr_id, node)

Returns the value of node node in nodal expression-based distribution with id nID

Parameters:

expr_id (int) – Nodal expression-based distribution ID [0, … ]
node (int) – Node index [0 … np_3d]

Returns:

Value of node node in nodal expression-based distribution nID.

Return type:

float

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNodalRefDistrIdByName(dist_name)

Retrieve the ID of the first nodal reference distribution with name identical to the search name.

Parameters:

dist_name (str) – Nodal reference distribution name string

Returns:

Reference distribution ID.

Return -1 if nodal reference distribution doesn’t exist.
To check identity: Compare the number of characters of the _name.

Return type:

int

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNodalRefDistrName(dist_id)

Retrieve the name of nodal reference distribution

Parameters:: dist_id (int) – Nodal reference distribution ID (0, … )
Returns:: The name of the nodal reference distribution with ID rID Return name “invalid” in case of invalid ID. Indexing starts with 0.
Return type:: str

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNodalRefDistrValue(dist_id, node)

Returns the value of node node in nodal reference distribution with id rID

Parameters:

dist_id (long) – Nodal reference distribution ID [0, … ]
node (long) – Node index [0 … np_3d]

Returns:

Value of node node in nodal reference distribution rID. Return 0.0 in case of invalid node ID or invalid nodal reference distribution id.

Return type:

float

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNodalRefDistrValueAtXYSlice(dist_id, x, y, slice)

Computes the interpolated value of nodal reference distribution at location (x, y, slice)

Parameters:

dist_id (long) – Nodal reference distribution ID [0, … ]
x (float) – Local X coordinate
y (float) – Local Y coordinate
slice (int) – Slice number [0, …]

Returns:

value at (x,y,slice) if inside of the model domain, otherwise None.

Return type:

float

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNodalRefDistrValueAtXYZ(dist_id, x, y, z)

Computes the interpolated value of nodal reference distribution at location (x,y,z)

Parameters:

dist_id (long) – Nodal reference distribution ID [0, … ]
x (float) – Local X coordinate
y (float) – Local Y coordinate
z (float) – Local Z coordinate (ignored in 2D)

Returns:

True if location (x,y,z) lies inside of the model domain, otherwise None.

Return type:

float

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNodalRefDistrValues(distr_id, start, count)

Fetch multiple values of a reference distribution addressed by id and range.

Parameters:

distr_id (int) – ID of nodal reference distribution
start (int, optional) – first node number to import
count (int, optional) – number of nodes to import

Returns:

nodal user distribution values

Return type:

list

Examples

>>> refd3 = doc.getNodalRefDistrValues(3)

getNode(element, Node)

Retrieve the node number of an element

Parameters:

element (int) – (Global) element index
Node (int) – Local node index (counterclockwise)

Returns:

The global node index for a given element

Return type:

int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getNodeElements(node)

Returns IDs of all adjacent elements.

Parameters:: node (int) – Node ID
Returns:: List of element IDs.
Return type:: list

getNumberOf1DFractureElements()

Retrieve the number of 1D fracture elements.

Returns:: The number of 1D fracture elements
Return type:: int

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getNumberOf2DQuadrilateralFractureElements()

GetNumberOf2DQuadrilateralFractureElements()

Retrieve the number of 2D quadrilateral fracture elements.

Returns:: The number of 2D quadrilateral fracture elements
Return type:: int

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getNumberOf2DTriangularFractureElements()

GetNumberOf2DTriangularFractureElements()

Retrieve the number of 2D triangularfracture elements.

Returns:: The number of 2D triangular fracture elements
Return type:: int

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getNumberOfBorderNodes(border_id)

Returns the number nodes belonging to a border

IfmGetNumberOfBorderNodes() returns the number nodes belonging to an exterior or interior border. Call IfmGetBorderNode() to retrieve the detailed node number.

Parameters:: border_id (int) – index of the exterior border
Returns:: Returns the number of nodes belonging to a border.
Return type:: int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getNumberOfBorders()

Returns the cumulative number of exterior and interior borders. To distinguish between exterior and interior borders the function isExteriorBorder() can be called or the orientation can be tested. Exterior borders have always a mathematically positive (counter clock wise) orientation whereas interior borders have a negative orientation (clock wise).

Returns:: Returns the absolute number of both exterior and interior borders.
Return type:: int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, a, llowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getNumberOfDimensions()

Number of dimensions (2 or 3)

Returns:: The dimension number
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfEdges()

Retrieve the number of finite element edges

Returns:: the number of edges
Return type:: int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getNumberOfElementNodes(element)

Returns number of nodes of an element

Parameters:: element (int) – element index
Returns:: number of nodes
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfElementNodes2D(int)

Get the number of nodes of a given element.

Parameters:: element (int) – element index
Returns:: number of nodes
Return type:: int

getNumberOfElementalExprDistr()

Retrieve the number of existing elemental expression-based distributions

Returns:: The number of existing elemental expression-based distributions
Return type:: int

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNumberOfElementalRefDistr()

Retrieve the number of existing elemental reference distributions

Returns:: The number of existing elemental reference distributions
Return type:: int

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNumberOfElements()

Total number of finite elements

Returns:: The total number of elements
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfElementsPerLayer()

Number of elements per layer or 0 for unstructured models

Returns:: The number of elements per layer
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfFaces()

Retrieve the number of finite element faces

Returns:: the number of faces
Return type:: int

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getNumberOfLayers()

Number of layers (carrying elements) or zero for unstructured meshes

Returns:: The number of layers
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfMultiLayerWells()

Get number of multilayer wells

Returns:: The cumulative number of multilayer wells of the FEM problem
Return type:: int

See also

getNumberOfNodalExprDistr()

Retrieve the number of existing nodal expression-based distributions

Returns:: The number of existing nodal expression-based distributions if > 0 nodal expression-based distributions exist if == 0 there are no nodal expression-based distributions
Return type:: int

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNumberOfNodalRefDistr()

Retrieve the number of existing nodal reference distributions

Returns:: The number of existing nodal reference distributions if > 0 nodal reference distributions exist if == 0 there are no nodal reference distributions
Return type:: int

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

getNumberOfNodeElements(node)

Retrieve the number of attached elements of a node.

Parameters:: node (int) – Node index
Returns:: The number of elements of the specified node.
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfNodes()

Total number of mesh nodes

Returns:: The total number of nodes
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfNodesPerElement()

Number of nodes per element for homogenous meshes or 0 otherwise

Returns:: The number of nodes per element
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfNodesPerElement2D()

Number of nodes per element for a 2D projection of homogenous meshes or zero otherwise

Returns:: The number of nodes per element for a 2D projection
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfNodesPerSlice()

Number of nodes per slice

Returns:: The number of nodes per slice
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfSelections(sel_type)

Retrieve the number of a certain kind selections

Parameters:: sel_type (Ifm.Enum.SEL_TYPE) – Selection type
Returns:: The number of selections of type nSelType
Return type:: int

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

getNumberOfSlices()

Number of slices (carrying the nodes) or zero for unstructured meshes

Returns:: The number of slices
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfSpecies()

GetNumberOfSpecies()

Retrieve the number of chemical species

Returns:: The number of chemical species (== 1 single species, > 1 multispecies transport
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getNumberOfTimeSteps()

Fetch number of time steps stored in the current DAC file.

Returns:: The number of DAC time steps
Return type:: int

getNumberOfTotalFractureElements()

Retrieve the total number of fracture elements.

Returns:: The total number of fracture elements
Return type:: int

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

getNumberOfValidGroups()

Retrieve the number of valid groups

Returns:: The number of valid groups
Return type:: int

See also

getNumberOfValidGroups, getMaximumNumberOfGroups, isNodeInGroup, getFlowValueOfGroupIdAtCurrentTime, getMassValueOfGroupIdAtCurrentTime, getHeatValueOfGroupIdAtCurrentTime

getNumberOfValidObsPoints()

Retrieve the number of valid observation points

Returns:: The number of valid observation points
Return type:: int

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getObsLabel(obs_id)

Retrieve the name for a given observation point

Parameters:: obs_id (int) – Observation point ID (0, … )
Returns:: The name of the observation point Indexing starts at 0
Return type:: str

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getOriginX()

Retrieve the absolute X coordinate of the origin

Returns:: The origin’s X coordinate. Physical unit is [m]
Return type:: float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getOriginY()

Retrieve the absolute Y coordinate of the origin

Returns:: The origin’s Y coordinate (double precision). Physical unit is [m].
Return type:: float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getOriginZ()

Retrieve the absolute Z coordinate of the origin

Returns:: The origin’s Z coordinate (double precision) Physical unit is [m]
Return type:: float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getParamExpression(parameter)

Get the expression that is set for a given parameter

Parameters:: parameter (ifm.Parameter) – The Parameter for
Returns:: The parameter expression as an XML string
Return type:: str

Examples

>>> ifmparameter = doc.getParameter(ifm.Enum.P_SOUF)
>>> xml = doc.getParamExpression(ifmparameter)

getParamPowId(param_id, item_index)

Fetch a power function of a parameter The function returns the power function id of a parameter or 0 if not identified by a unique parameter code.

Parameters:

param_id (Ifm.Enum.P_<x>) – Parameter identification code
item_index (int) – Item index, e.g., node number

Returns:

The current value of the parameter item with index iItem. Indexing starts with 0.

Return type:

int

See also

getParamPowIds(param_id[, first_item[, item_count]])

Fetch multiple parameter values The function returns parameter values at current time in an array of a parameter identified by a unique parameter code. The range of items to transfer is determined by start index and a counter.

Parameters:

param_id (int) – Parameter identification code Ifm.Enum.P_BC_*
first_item (int) – Index of first item to obtain
item_count (int) – Number of items to obtain

Returns:

A list of time series ids assigned to the items.

Return type:

int

See also

getParamSize(param_id)

Fetch number of item of a parameter

Parameters:: param_id (int) – Parameter identification code IfmP_*
Returns:: The number of items in the parameter, e.g. # of elements, nodes, dfe
Return type:: int

Examples

>>> ne = ifm.getParamSize(ifm.Enum.P_SOUF)

See also

getParamValue(parameter, item)

Fetch value of a parameter addressed by id and index This functions returns values of elements, nodes, and fracture elements.

Parameters:

parameter (int or [int, str]) – Parameter identification code IfmP_*
item (int) – Item index, e.g., node or element number

Returns:

The current value of the parameter item with index iItem.

Return type:

float

Example

>>> source_sink = ifm.getParamValue(ifm.Enum.P_SOUF, 0)

See also

getParamValues(int param_id[, int start[, int count]])

Fetch multiple values of a parameter addressed by id and range This functions returns values of elements, nodes, and fracture elements.

Parameters:

parameter (int or [int, str]) – Parameter identification code IfmP_*
start (int, optional) – Index of first item to transfer
count (int, optional) – Number of items to transfer
indices ([int], optional) – lsit of indices

Returns:

The number of transfered item values.

Return type:

[float]

Examples

>>> # to get all parameter values
>>> source_sink = doc.getParamValues(ifm.Enum.P_SOUF)
>>> # to get parameter values from a range: Source/Sink values for 3 elements from ID 100
>>> doc.getParamValues(ifm.Enum.P_SOUF, 100, 3)
>>> # to get parameter values of a selection
>>> top_elems = doc.getSelectionItems(ifm.Enum.SEL_ELEMS, "toplayer")
>>> doc.getParamValues(ifm.Enum.P_SOUF,top_elems)

See also

getParameter(param_id, param_subid)

Get parameter from id and subid The function returns a reference to a parameter identified by a unique parameter code and a parameter-dependent substring.

Parameters:

param_id (IfmParamID) – Parameter identification code IfmP_*
param_subid (str) – Parameter identification subid, e.g., reference distribution name, species name, aux function id

Returns:

A parameter object handle to be used in IfmGetParam() and IfmSetParam() functions

Return type:

Ifm.Parameter

See also

getPredictorCorrectorMethod()

Retrieve the method of predictor-corrector time stepping

ifm.Enum.PCS_FEBE (0) = Forward Euler/Backward Euler (FE/BE)
ifm.Enum.PCS_ABTR (1) = Adams-Bashforth/Trapezoid Rule (AB/TR)

Returns:: The method of predictor-corrector time stepping
Return type:: int

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getPredictorCorrectorTimeStepIncreasingRate()

Retrieve the time step increasing rate used for predictor-corrector time stepping schemes

Returns:: The time step increasing rate. Rate is dimensionless
Return type:: float

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getPredictorCorrectorTimeStepMaximumSize()

Retrieve the maximum time step size applied to predictor-corrector time stepping schemes

Returns:: The maximum time step size. Physical unit is [d]
Return type:: float

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getPredictorHeadTimeValue(node)

Retrieve the predictor value for the hydraulic head at the current time step for a transient flow problem in using a predictor-corrector time stepping scheme

Parameters:: node (int) – Node number
Returns:: The predictor value for the hydraulic head. Physical unit is [m], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getPredictorHeatTimeValue(node)

Retrieve the predictor value for temperature (heat) at the current time step for a transient heat transport problem in using a predictor-corrector time stepping scheme

Parameters:: node (int) – Node number
Returns:: The predictor value for the temperature (heat). Physical unit is [deg C], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getPredictorMassTimeValue(node)

Retrieve the predictor value for mass (concentration) at the current time step for a transient mass transport problem in using a predictor-corrector time stepping scheme

Parameters:: node (int) – Node number
Returns:: The predictor value for the mass (concentration) Physical unit is [mg/l], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getPressureValueOfObsIdAtCurrentTime(oID)

Retrieve the value of pressure for a given observation point ID at current time

Parameters:: oID (int) – Observation point ID (0, … )
Returns:: The pressure value of a given observation point ID at current time The value is related to the current simulation time Physical unit is [kPa] Indexing starts with 0.
Return type:: float

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getProblemClass()

Retrieve the class of problem.

ifm.Enum.PCLS_NO_CLASS (-1) = illegal problem class
ifm.Enum.PCLS_FLOW (0) = separate flow simulation
ifm.Enum.PCLS_MASS_TRANSPORT (1) = combined flow and mass transport
ifm.Enum.PCLS_HEAT_TRANSPORT (2) = combined flow and heat transport
ifm.Enum.PCLS_THERMOHALINE (3) = combined flow, mass and heat transport
ifm.Enum.PCLS_AGE_TRANSPORT (4) = combined flow and age transport
ifm.Enum.PCLS_MASS_AGE_TRANSPORT (5) = Combined flow, mass, and age transport
ifm.Enum.PCLS_HEAT_AGE_TRANSPORT (6) = Combined flow, heat, and age transport
ifm.Enum.PCLS_MASS_AGE_HEAT_TRANSPORT (7) = Combined flow, mass, age, and heat transport

Returns:: The class of the used problem
Return type:: IfmProblemClass

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getProblemDefinition()

Create a Problem Definition Instance.

Returns:: Problem Definition Instance
Return type:: ifm.ProblemDefinition

Examples

>>> pdf = doc.getProblemDefinition()

See also

ifm.ProblemDefinition

getProblemDescription()

Retrieve the description of the current FEM or DAC problem. IfmGetProblemDescription() returns the text defined in the problem settings editor.

Returns:: The file title.
Return type:: str

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getProblemPath()

Retrieve the full path of the current FEM or DAC problem. IfmGetProblemPath() returns the full file name including the path information. For a new problem, an empty string is returned.

Returns:: path to the FEM/DAC file
Return type:: str

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getProblemProjection()

Retrieve the type of problem projection.

ifm.Enum.PROJ_UNDEF_PROJ (-1) = undefined projection
ifm.Enum.PROJ_CONFINED_2D (0) = horizontal confined 2D aquifer
ifm.Enum.PROJ_PHREATIC_2D (1) = horizontal phreatic 2D aquifer
ifm.Enum.PROJ_VERTICAL_2D (2) = vertical confined 2D aquifer
ifm.Enum.PROJ_AXISYM_2D (3) = vertical confined axisymmetric
ifm.Enum.PROJ_CONFINED_3D (4) = 3D confined aquifer
ifm.Enum.PROJ_PHREATIC_3D (5) = 3D phreatic aquifer (fixed mesh)
ifm.Enum.PROJ_MOVE_FS_3D (6) = 3D aquifer with movable free surface

The projection is dependent on the problem dimension. It indicates whether problems with (phreatic) and without (confined) free surfaces are chosen. For vertical problems (planar and axisymmetric) a free surface problem is only available as an unsaturated problem type.

Returns:: The problem projection flag
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getProblemTitle()

Retrieve the title of the current FEM or DAC problem. IfmGetProblemTitle() returns the file name part of the current problem without the path information. It should be used for displaying purposes. Currently, “Untitled” is returned for a new problem.

Returns:: The file title.
Return type:: str

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getProblemType()

Retrieve the type of problem.

ifm.Enum.TYPE_SATURATED (0) = saturated media (groundwater)
ifm.Enum.TYPE_UNSATURATED (1) = unsaturated media

Returns:: Problem type flag
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getProtectionZone(species, factor, nodes, budgetComponents[, root_method, mxits, eps0, eps1, eps2])

Extract an exit probability value for protection zone definition.

Parameters:

species (int) – Species ID
factor (float) – Factor to apply to target flowrate. Its value can be any number between 0 and 1.
nodes (list of int) – List of node IDs included in the capture zone
budgetComponents (list of int) – Budget component to account for, of dimension = len(nodes)
root_method (int) – Root finding method: 1 = Bisection, 2 = Brent
mxits (int) – Maximum number of iterations allowed: 20
eps0 (float) – Positive/Negative tolerance on function values: 1.0e-04 (Brent)
eps1 (float) – Step-size tolerance: 1.0e-06 (Brent)
eps2 (float) – Convergence tolerance: 1.0e-06 (Brent)

Returns:

The value of the exit-probability satisfying the requested constraint on target flowrate.

Return type:

double

See also

Example

>>> nodes_Selec1 = doc.getSelectionItems(ifm.Enum.SEL_NODES, "capture1_nodes")
>>> spID = doc.findSpecies("Exit")
>>> for i in range(0, len(nodes_Selec1)):
>>>    budgetComp.append(1)
>>> value = doc.getProtectionZone(0, 0.95, 3, [0, 2, 7], [ifm.Enum.BUDGET_BOUNDARY, ifm.Enum.BUDGET_BULK, ifm.Enum.BUDGET_BULK])
>>> print(value)
>>> 0.6431865692138672

getReferenceTemperature()

GetReferenceTemperature()

Retrieve reference temperature

Returns:: reference temperature [oC] otherwise 0.0 if function failed
Return type:: float

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

getReferenceTime()

Retrieve the reference time.

Returns:: The reference time
Return type:: datetime.datetime

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getResultsElementalVelocityValuesAtXYZ(x, y, z)

Retrieve the elemental (discontinuous) Darcy velocity components at given coordinates (x,y,z) and current time.

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
z (float) – z-coordinate of the point

Returns:

Discontinuous (elemental) velocity components (vx,vy,vz)

Physical unit is [m/d]. The value is related to the current simulation time. The point (x,y,z) represents mesh coordinates that excludes any coordinate offset. Also applicable in 2D if z-coordinate is used as dummy.

Return type:

(float, float, float)

See also

getResultsFlowHeadPreviousTimeValue(node)

Retrieve the hydraulic head value at previous time step for a transient flow problem

Parameters:: node (int) – Node number
Returns:: The hydraulic head value at previous time step. Physical unit is [m], The value is related to the previous simulation time Indexing starts with 0.
Return type:: float

See also

getResultsFlowHeadValue(node)

Retrieve the resulting hydraulic head value for a flow problem

Parameters:: node (int) – Node number
Returns:: The resulting hydraulic head value for a flow problem. Physical unit is [m], The value is related to the current simulation time.
Return type:: float

See also

getResultsFlowHeadValueAtXYSlice(x, y, slice)

Retrieve the resulting hydraulic head value at given horizontal x-y-coordinates and the slice number for current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
slice (int) – Slice index (0 <= slc < n_slices); Note: index starts with 0

Returns:

The resulting hydraulic head value at given horizontal x-y-coordinates, slice number and current time Physical unit is [m]. The value is related to the current simulation time.

Return type:

float

See also

getResultsFlowHeadValueAtXYZ(x, y, z)

Retrieve the resulting hydraulic head value at given coordinates (x,y,z) and current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
z (float) – z-coordinate of the point

Returns:

The resulting hydraulic head value at given coordinates (x,y,z) and current time Physical unit is [m]. The value is related to the current simulation time.

Return type:

float

See also

getResultsFlowMoistureContentValue(node)

Retrieve the resulting moisture content value for an unsaturated flow problem

Parameters:: node (int) – Node number
Returns:: The resulting moisture content value for an unsaturated flow problem Physical unit is [1], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getResultsFlowMoistureContentValueAtXYSlice(x, y, slice)

Retrieve the resulting moisture content value at given horizontal x-y-coordinates and the slice number for current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
slice (int) – Slice index (0 <= slc < n_slices); Note: index starts with 0

Returns:

The resulting moisture content value at given horizontal x-y-coordinates, slice number and current time Physical unit is [1]. The value is related to the current simulation time.

Return type:

float

See also

getResultsFlowMoistureContentValueAtXYZ(x, y, z)

Retrieve the resulting moisture content value at given coordinates (x,y,z) and current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
z (float) – z-coordinate of the point

Returns:

The resulting moisture content value at given coordinates (x,y,z) and current time Physical unit is [1]. The value is related to the current simulation time.

Return type:

float

See also

getResultsFlowPressureValue(node)

Retrieve the resulting pressure value for a flow problem

Parameters:: node (int) – Node number
Returns:: The resulting pressure value for a flow problem Physical unit is [kPa], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getResultsFlowPressureValueAtXYSlice(x, y, slice)

Retrieve the resulting pressure value at given horizontal x-y-coordinates and the slice number for current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
slicc (int) – Slice index (0 <= slc < n_slices); Note: index starts with 0

Returns:

The resulting pressure value at horizontal x-y-coordinates, slice number and current time

Physical unit is [kPa]. The value is related to the current simulation time. The returned value is only valid if the flag ‘ine’ is True. If ine = False the point (x,y) is outside the mesh or the slice number is invalid. The point (x,y) represents mesh coordinates that excludes any coordinate offset. Indexing starts with 0.

Return type:

float

See also

getResultsFlowPressureValueAtXYZ(x, y, z)

Retrieve the resulting pressure value at given coordinates (x,y,z) and current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
z (float) – z-coordinate of the point

Returns:

The resulting pressure value at given coordinates (x,y,z) and current time Physical unit is [kPa]. The value is related to the current simulation time.

Return type:

float

See also

getResultsFlowSaturationValue(node)

Retrieve the resulting saturation value for an unsaturated flow problem

Parameters:: node (int) – Node number
Returns:: The resulting saturation value for an unsaturated flow problem Physical unit is [1], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getResultsFlowSaturationValueAtXYSlice(x, y, slice)

Retrieve the resulting saturation value at given horizontal x-y-coordinates and the slice number for current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
slice (int) – Slice index (0 <= slc < n_slices); Note: index starts with 0

Returns:

The resulting saturation value at given horizontal x-y-coordinates, slice number and current time Physical unit is [1]. The value is related to the current simulation time.

Return type:

float

See also

getResultsFlowSaturationValueAtXYZ(x, y, z)

Retrieve the resulting saturation value at given coordinates (x,y,z) and current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
z (float) – z-coordinate of the point

Returns:

The resulting saturation value at given coordinates (x,y,z) and current time Physical unit is [1]. The value is related to the current simulation time. The returned value is only valid if the flag ‘ine’ is True. If ine = False the point (x,y,z) is outside the mesh. The point (x,y,z) represents mesh coordinates that excludes any coordinate offset. Indexing starts with 0.

Return type:

float

See also

getResultsNodalVelocityValuesAtXYZ(x, y, z)

Get the Darcy velocity at a specified (x, y, z) coordinate in the model.

Parameters:

x (float) – Local Coordinates
y (float) – Local Coordinates
z (float) – Local Coordinates

Returns:

Darcy Velocity

Return type:

float

getResultsTransportHeatPreviousTimeValue(node)

Retrieve the temperature (heat) at previous time step for a transient heat transport problem

Parameters:: node (int) – Node number
Returns:: The temperature (heat) value at previous time step Physical unit is [deg C], The value is related to the previous simulation time Indexing starts with 0.
Return type:: float

See also

getResultsTransportHeatValue(node)

Retrieve the resulting temperature (heat) value for a transport problem

Parameters:: node (int) – Node number
Returns:: The resulting temperature (heat) value for a transport problem Physical unit is [deg C], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getResultsTransportHeatValueAtXYSlice(x, y, slice)

Retrieve the resulting temperature (heat) value at given horizontal x-y-coordinates and the slice number for current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
slice (int) – Slice index (0 <= slc < n_slices); Note: index starts with 0

Returns:

The resulting temperature value at given horizontal x-y-coordinates, slice number and current time Physical unit is [deg C]. The value is related to the current simulation time.

Return type:

float

See also

getResultsTransportHeatValueAtXYZ(x, y, z)

Retrieve the resulting temperature (heat) value at given coordinates (x,y,z) and current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
z (float) – z-coordinate of the point

Returns:

The resulting temperature value at given coordinates (x,y,z) and current time Physical unit is [deg C]. The value is related to the current simulation time.

Return type:

float

See also

getResultsTransportMassPreviousTimeValue(node)

Retrieve the mass (concentration) at previous time step for a transient mass transport problem

Parameters:: node (int) – Node number
Returns:: The mass (concentration) value at previous time step Physical unit is [mg/l], The value is related to the previous simulation time Indexing starts with 0.
Return type:: float

See also

getResultsTransportMassValue(node)

Retrieve the resulting mass (concentration) value for a transport problem

Parameters:: node (int) – Node number
Returns:: The resulting mass (concentration) value for a transport problem Physical unit is [mg/l], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getResultsTransportMassValueAtXYSlice(x, y, slice)

Retrieve the resulting mass (concentration) value at given horizontal x-y-coordinates and the slice number for current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
slice (int) – Slice index (0 <= slc < n_slices); Note: index starts with 0

Returns:

The resulting concentration value at given horizontal x-y-coordinates, slice number and current time Physical unit is [mg/l]. The value is related to the current simulation time.

Return type:

float

See also

getResultsTransportMassValueAtXYZ(x, y, z)

Retrieve the resulting mass (concentration) value at given coordinates (x,y,z) and current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
z (float) – z-coordinate of the point

Returns:

The resulting concentration value at given coordinates (x,y,z) and current time

Return type:

float

Notes

Physical unit is [mg/l]. The value is related to the current simulation time. The returned value is only valid if the flag ‘ine’ is True. If ine = False the point (x,y,z) is outside the mesh. The point (x,y,z) represents mesh coordinates that excludes any coordinate offset. Indexing starts with 0.

See also

getResultsVelocityNormValue(node)

Retrieve the resulting velocity norm of the Darcy flux (length of vector)

Parameters:: node (int) – Node number
Returns:: The resulting Darcy velocity norm value Physical unit is [m/d], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getResultsXVelocityValue(node)

Retrieve the resulting x-component of the Darcy velocity vector

Parameters:: node (int) – Node number
Returns:: The resulting Darcy x-velocity value Physical unit is [m/d], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getResultsXVelocityValueAtXYZ(x, y, z)

Retrieve the resulting x-component of the Darcy velocity vector at given coordinates (x,y,z) and current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
z (float) – z-coordinate of the point

Returns:

The resulting Darcy x-velocity value at given coordinates (x,y,z) and current time Physical unit is [m/d]. The value is related to the current simulation time.

Return type:

float

See also

getResultsYVelocityValue(node)

Retrieve the resulting y-component of the Darcy velocity vector

Parameters:: node (int) – Node number
Returns:: The resulting Darcy y-velocity value Physical unit is [m/d], The value is related to the current simulation time Indexing starts with 0.
Return type:: float

See also

getResultsYVelocityValueAtXYZ(x, y, z)

Retrieve the resulting y-component of the Darcy velocity vector at given coordinates (x,y,z) and current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
z (float) – z-coordinate of the point

Returns:

The resulting Darcy y-velocity value at given coordinates (x,y,z) and current time Physical unit is [m/d]. The value is related to the current simulation time.

Return type:

float

See also

getResultsZVelocityValue(node)

Retrieve the resulting z-component of the Darcy velocity vector

Parameters:: node (int) – Node number
Returns:: The resulting Darcy z-velocity value Physical unit is [m/d], The value is related to the current simulation time. Indexing starts with 0.
Return type:: float

See also

getResultsZVelocityValueAtXYZ(x, y, z)

Retrieve the resulting z-component of the Darcy velocity vector at given coordinates (x,y,z) and current time

Parameters:

x (float) – x-coordinate of the point
y (float) – y-coordinate of the point
z (float) – z-coordinate of the point

Returns:

The resulting Darcy z-velocity value at given coordinates (x,y,z) and current time Physical unit is [m/d]. The value is related to the current simulation time.

Return type:

float

See also

getRichardsEquationFormType()

Retrieve the form of the Richards equation

ifm.Enum.UFORM_H (0) = Standard h-based form
ifm.Enum.UFORM_MIXED (1) = Mixed s-h form
ifm.Enum.UFORM_VARSUB (2) = Variable substitution form

Returns:: The form of the Richards equation
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSaturationValueOfObsIdAtCurrentTime(obs_id)

Retrieve the value of saturation for a given observation point ID at current time

Parameters:: obs_id (int) – Observation point ID (0, … )
Returns:: The saturation value of a given observation point ID at current time The value is related to the current simulation time Physical unit is [1] Indexing starts with 0.
Return type:: float

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getSaveVersion()

Retrieve module version written into the FEM file IfmGetSaveVersion() returns the version that will be used when Serialize writes the modules related document data into FEFLOW’s FEM file. Depending on this number (hexadecimal) the Serialize method should restrict it’s I/O to those parts supported by this version.

Returns:: Version to be written into FEM file.
Return type:: str

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSelectionCapacity(sel_type)

Retrieve the max. number items that can be hold in a selection defined by type. The capacity of the current selection types corresponds with # of nodes and # of elements, resp.

Parameters:: sel_type (int) – Selection type
Returns:: The max. number of items of this selection type
Return type:: int

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

getSelectionItemCount(sel_type, sel_index)

Get Number of Item in specified selection

Parameters:

sel_type ({'ifm.Enum.SEL_EDGES', 'ifm.Enum.SEL_ELEMENTAL', 'ifm.Enum.SEL_FACES', 'ifm.Enum.SEL_FRACS', 'ifm.Enum.SEL_NODAL'}) – Selection Type
sel_index (int) – Selection Index

Returns:

number of items in selection

Return type:

int

getSelectionItems(sel_type, selection)

Fetch all items of a selection

Parameters:

sel_type (IfmSEL_TYPE) – Selection type
selection (int or str) – Selection index or name

Returns:

item indices

Return type:

[int]

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

getSelectionName(sel_type, sel_id)

Retrieve the name of a selection defined by type and index

Parameters:

sel_type (Ifm.Enum.SEL_TYPE) – Selection type
sel_id (int) – Selection index

Returns:

The unique selection name or “<current>” for the current selection (if exists)

Return type:

str

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

getSolutionResidualNorm2(problem_class)

Retrieve the L2 norm of the solution residual

ifm.Enum.PCLS_FLOW (0) residual norm of the flow solution step
ifm.Enum.PCLS_MASS_TRANSPORT (1) residual norm of the mass solution step
ifm.Enum.PCLS_HEAT_TRANSPORT (2) residual norm of the heat solution step

Parameters:: problem_class ({ifm.Enum.PCLS_FLOW, ifm.Enum.PCLS_MASS_TRANSPORT, ifm.Enum.PCLS_HEAT_TRANSPORT}) – problem class
Returns:: The L2 norm of the solution residual to the corresponding problem class
Return type:: float

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSolutionResidualNormMax(problem_class)

Retrieve the maximum norm of the solution residual (flow or transport residual as specified by parameter problem_class)

Parameters:: problem_class ({ifm.Enum.PCLS_FLOW, ifm.Enum.PCLS_MASS_TRANSPORT, ifm.Enum.PCLS_HEAT_TRANSPORT}) – problem class
Returns:: The L2 norm of the solution residual to the corresponding problem class
Return type:: float

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSpeciesKineticsArrhenius(species_id)

Retrieve Arrhenius reactions kinetics parameter.

Parameters:: species_id (int) – Species index
Returns:: Arrhenius reactions kinetics parameter
Return type:: float

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSpeciesKineticsDegradation(species_id)

Retrieve degradation reactions kinetics parameter.

Parameters:: species_id (int) – Species index
Returns:: (Array of coefficients K[iSpecies] , Array of exponents N[iSpecies])
Return type:: tuple

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSpeciesKineticsMonod(species_id)

Retrieve Monod reactions kinetics parameter.

Parameters:: species_id (int) – Species index
Returns:: (Coefficient array K[], Exponent array n[], Coefficient array B[], Coefficient array D[], Coefficient array E[])
Return type:: tuple

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSpeciesKineticsType(species_id)

Retrieve the reaction kinetics type of a given species.

Possible return values are: - ifm.Enum.KM_DEGRADATION - Degradation-type reaction kinetics type - ifm.Enum.KM_ARRHENIUS - Arrhenius-type reaction kinetics type - ifm.Enum.KM_MONOD - Monod-type reaction kinetics type - ifm.Enum.KM_USER_SPECIFIED - User-specified reaction kinetics type

Parameters:: species_id (int) – Species ID
Returns:: reaction kinetics type
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSpeciesKineticsUserDefined(species_id)

Retrieve degradation reactions kinetics parameter.

Parameters:: species_id (int) – Species index
Returns:: xml_string
Return type:: str

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSpeciesName(species_id)

Retrieve the name of a given species.

Parameters:: species_id (int) – Species 0 <= nId < IfmGetNumberOfSpecies()
Returns:: The name associated with the species Id.
Return type:: str

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSpeciesPhaseType(species_id)

Retrieve the phase type of a given species The species Id must be >= 0 and < IfmGetNumberOfSpecies()

Possible return values are:

ifm.Enum.FLUID_PHASE - Fluid phase type
ifm.Enum.SOLID_PHASE - Solid phase type

Parameters:: species_id (int) – Species 0 <= nId < IfmGetNumberOfSpecies()
Returns:: phase
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSpeciesType(species_id)

Retrieve the type of a species

Parameters:: species_id (int) – Index of species
Returns:: the current species type
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getSplineConductivityFunction(spline_id)

Retrieves the spline function dataset for relative conductivity function.

Parameters:: spline_id (int) – Spline ID number (1, 2, …) requested
Returns:: spline
Return type:: object

See also

getSplineConductivityFunction2(spline_id, int)

Retrieves the spline function dataset for relative conductivity function.

Parameters:: spline_id (int) – Spline ID number (1, 2, …) requested
Returns:: spline
Return type:: object

Notes

For nknt >= 0 the arrays (x, y, and stdev) HAVE TO BE ALLOCATED in sufficient length (and later freed) by the user. Otherwise, the arrays will be allocated IFM and have to be freed by calling IfmFreeMem!

See also

getSplineConductivityId(element, curveType)

Retrieve the Spline Id number of relative conductivity function at given element number

Parameters:

element (int) – Element number
curveType ({ifm.Enum.WETTING_CURVE(0), ifm.Enum.DRYING_CURVE(1)}) – curve type. ifm.Enum.DRYING_CURVE is only appropriate for hysteretic problems

Returns:

The Spline Id number > 0 if valid otherwise -1 if no spline data exist if number ‘element’ is invalid if the problem is not unsaturated if drying curve Id is requested, but the problem is non-hysteretic if there is no spline parameter model set for the given element number Element indexing starts with 0.

Return type:

int

See also

getSplineSaturationFunction(spline_id)

Retrieves the spline function dataset for capillary saturation function.

Parameters:: spline_id (int) – Spline ID number (1, 2, …) requested
Returns:: Spline Dataset
Return type:: object

See also

getSplineSaturationFunction2(spline_id)

Retrieves the spline function dataset for capillary saturation function.

Parameters:: spline_id (int) – Spline ID number (1, 2, …) requested
Returns:: True if successful, otherwise False if failed.
Return type:: bool

See also

getSplineSaturationId(element, curveType)

Retrieve the Spline Id number of saturation function at given element number

Parameters:

element (int) – Element number
curveType (int) – ifm.Enum.WETTING_CURVE(0) | ifm.Enum.DRYING_CURVE(1) NOTE: ifm.Enum.DRYING_CURVE is only appropriate for hysteretic problems

Returns:

The Spline Id number > 0 if valid otherwise -1 if no spline data exist if number ‘element’ is invalid if the problem is not unsaturated if drying curve Id is requested, but the problem is non-hysteretic if there is no spline parameter model set for the given element number. Element indexing starts with 0.

Return type:

int

See also

getSuperMesh()

Create a Supermesh Instance.

getSuperMesh() returns a Supermesh object which can then be costumized by the user.

Returns:: Supermesh Instance
Return type:: ifm.SuperMesh

Examples

>>> smh = doc.getSuperMesh()

See also

ifm.SuperMesh

getTimeClass()

Retrieve the class of time regime.

ifm.Enum.TCLS_STEADY (0) = steady flow / steady transport
ifm.Enum.TCLS_UNSTEADY (1) = fully unsteady flow / unsteady transport
ifm.Enum.TCLS_ST_UNST (2) = steady flow / unsteady transport

The time class is related to the ProblemClass. For instance, if the problem class is ifm.Enum.PCLS_FLOW (separate flow simulation) the ifm.Enum.TCLS_STEADY flag indicates a steady flow. If the problem class is ifm.Enum.PCLS_THERMOHALINE and the time class is ifm.Enum.TCLS_UNSTEADY, both flow, mass and heat transport are fully transient. The time class ifm.Enum.TCLS_ST_UNST exists only for transport problems and is not available for a separate flow problem (for problem cass ifm.Enum.PCLS_FLOW).

Returns:: The class of the time regime.
Return type:: {ifm.Enum.TCLS_STEADY, ifm.Enum.TCLS_UNSTEADY, ifm.Enum.TCLS_ST_UNST}

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getTimeSteppingErrorTolerance()

Retrieve the error tolerance for the adaptive time stepping scheme

Returns:: The error tolerance specified by the user Tolerance is dimensionless
Return type:: float

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getTimeSteppingKind()

Retrieve the kind of time stepping

ifm.Enum.KTS_PCS (0) = Predictor-corrector scheme
ifm.Enum.KTS_CTS (1) = Constant time stepping scheme

Returns:: The time stepping flag
Return type:: {ifm.Enum.KTS_PCS, ifm.Enum.KTS_CTS}

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

getTimeSteps()

Fetch list of time steps stored in the current DAC file.

Returns:: a two-dimensional array of time steps, index 0 contains the simulation step number (may be different from index on sparse DACs), index 1 contains the simulation step time
Return type:: [[int], [float]]

Examples

>>> steps = doc.getTimeSteps()
>>>     for i in range(0,len(steps)):
>>>         print('index=' + str(i) + ', step=' + str(steps[i][0]) + ', time=' + str(steps[i][1]))

getTotalContent(type)

Retrieve the total content value at current time

Parameters:: type (IfmContentType) – Type of content (see above: ifm.Enum.TOTAL_VOLUME, ifm.Enum.VOID_VOLUME …)
Returns:: The content value for different content types: - ifm.Enum.TOTAL_VOLUME (0) = Total volume - ifm.Enum.VOID_VOLUME (1) = Void volume - ifm.Enum.FLUID_CONTENT (2) = Fluid content - ifm.Enum.DILUTED_MASS (3) = Diluted mass (fluid phase) - ifm.Enum.SORBED_MASS (4) = Sorbed mass (solid phase) - ifm.Enum.ENERGY_FLUID (5) = Energy of fluid phase - ifm.Enum.ENERGY_SOLID (6) = Energy of solid phase - ifm.Enum.ENERGY_TOTAL (7) = Total energy content
Return type:: float

Notes

Physical units depend on the content type: - ifm.Enum.TOTAL_VOLUME [m3] - ifm.Enum.VOID_VOLUME [m3] - ifm.Enum.FLUID_CONTENT [m3] - ifm.Enum.DILUTED_MASS [g] - ifm.Enum.SORBED_MASS [g] - ifm.Enum.ENERGY_FLUID [J] - ifm.Enum.ENERGY_SOLID [J] - ifm.Enum.ENERGY_TOTAL [J]

See also

getTotalContent, getElementalContent, getTotalContent2, getElementalContent2, integrateNodalQuantitiesOfElement

getTotalContent2(type, v_low, v_high)

Retrieve the total content value at current time

Parameters:

type (IfmContentType2) – Type of content (see above: ifm.Enum.TOTAL_VOLUME, ifm.Enum.VOID_VOLUME …)
v_low (float) – <undocumented>
v_high (float) – <undocumented>

Returns:

The content value for different content types: - ifm.Enum.TOTAL_VOLUME (0) = Total volume - ifm.Enum.VOID_VOLUME (1) = Void volume - ifm.Enum.FLUID_CONTENT (2) = Fluid content - ifm.Enum.DILUTED_MASS (3) = Diluted mass (fluid phase) - ifm.Enum.SORBED_MASS (4) = Sorbed mass (solid phase) - ifm.Enum.ENERGY_FLUID (5) = Energy of fluid phase - ifm.Enum.ENERGY_SOLID (6) = Energy of solid phase - ifm.Enum.ENERGY_TOTAL (7) = Total energy content

Return type:

int

Notes

Physical units depend on the content type: - ifm.Enum.TOTAL_VOLUME [m3] - ifm.Enum.VOID_VOLUME [m3] - ifm.Enum.FLUID_CONTENT [m3] - ifm.Enum.DILUTED_MASS [g] - ifm.Enum.SORBED_MASS [g] - ifm.Enum.ENERGY_FLUID [J] - ifm.Enum.ENERGY_SOLID [J] - ifm.Enum.ENERGY_TOTAL [J]

See also

getTotalContent, getElementalContent, getTotalContent2, getElementalContent2, integrateNodalQuantitiesOfElement

getTypeOfObsId(obs_id)

Retrieve the flag for identifying an observation point ID

Parameters:: obs_id (int) – Observation point ID (0, … )
Returns:: The type of nodal identifier. if >= 0 observation point is nodal and the node number is returned, if < 0 observation point is arbitrary placed (no node). Indexing starts with 0.
Return type:: int

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getUnsatDerivativeCapaType()

Retrieve the type of derivation of the capacity term

Returns:: The type of derivation of the capacity term - ifm.Enum.CAPA_CSS (0) = Chord-slope scheme - ifm.Enum.CAPA_ANA (1) = Analytical scheme - ifm.Enum.CAPA_ANA_TCE (2) = Time-centred analytic scheme
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getUnsatErrorCheckOption()

Retrieve the error check option for unsaturated problems

Returns:: The error check option for unsaturated problems - ifm.Enum.CPS_DONT (0) = Don’t check capillary head and saturation error; if applicable, check residual - ifm.Enum.CPS_DO (1) = Check capillary head and saturation error; if applicable, check residual - ifm.Enum.CPS_OMITRES (2) = Don’t check capillary head and saturation error; don’t check residual - ifm.Enum.CPS_OMITRES_DO (3) = Check capillary head and saturation error; don’t check residual
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getUnsatHysteresisCondition()

GetUnsatHysteresisCondition: Only appropriate for unsaturated problems

Retrieve the flag of hysteretic unsaturated problems

Returns:: The flag whether hysteresis exists for unsaturated problems - (0) = no hysteresis - (1) = with hysteresis
Return type:: {0,1}

See also

getUnsatHysteresisIndicatorValue(element)

Retrieve the indicator value in the computation of hysteretic unsaturated problems

Parameters:: element (int) – Element number
Returns:: The indicator value at the current simulation time as follows: - ifm.Enum.NEUTRAL_DIRECTION (0) = neutral state (average of wetting and drying) - ifm.Enum.WETTING_DIRECTION (1) = wetting direction - ifm.Enum.DRYING_DIRECTION (-1) = drying direction
Return type:: int

See also

getUnsatHysteresisIndicatorValueAtNode(node)

Retrieve the indicator value in the computation of hysteretic unsaturated problems

Parameters:: node (int) – Node number
Returns:: The indicator value at the current simulation time as follows: ifm.Enum.NEUTRAL_DIRECTION (0) = neutral state (average of wetting and drying) ifm.Enum.WETTING_DIRECTION (1) = wetting direction ifm.Enum.DRYING_DIRECTION (-1) = drying direction Indexing starts with 0.
Return type:: int

See also

getUnsatHysteresisStarValue(element)

Retrieve the saturation ‘star’ value in the computation of hysteretic unsaturated problems

Parameters:: element (int) – Element number
Returns:: The saturation ‘star’ value at the current simulation time Physical unit is [1], Indexing starts with 0.
Return type:: float

See also

getUnsatHysteresisStarValueAtNode(element, LocalNode)

Retrieve the saturation ‘star’ value in the computation of hysteretic unsaturated problems

Parameters:

element (int) – Element number
LocalNode (int) – Local node number

Returns:

The saturation ‘star’ value at the current simulation time Physical unit is [1], Indexing starts with 0.

Return type:

float

See also

getUnsatIterationMethod()

Retrieve the iteration method used for unsaturated problems

Returns:: The iteration method used for unsaturated problems - ifm.Enum.US_PICARD (0) = Picard iteration scheme - ifm.Enum.US_NEWTON (1) = Newton iteration scheme
Return type:: {0, 1}

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getUnsatWeightingType()

Retrieve the type of weighting for unsaturated problems

Returns:: The type of weighting for unsaturated problems - ifm.Enum.ICM_CW (0) = Central weighting - ifm.Enum.ICM_UPW (1) = Upstream weighting
Return type:: {0, 1}

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

getUserMetaData()

Retrieve the User Meta Information saved in the FEFLOW model (Problem Settings).

Returns:: User Meta Information
Return type:: string

See also

getMetaData, parseUserMetaData, setUserMetaData

getViscosityDependency()

GetViscosityDependency()

Retrieve viscosity expression of selected element

Returns:: Viscosity expression as UTF-8 encoded XML string or NULL if not defined
Return type:: str

See also

getX(node)

IfmGetX - Retrieve the X coordinate of a node relative to the origin

Parameters:: node (int) – Node number
Returns:: The node’s X coordinate Physical unit is [m] Indexing starts at 0
Return type:: float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getXOfObsId(oID)

Retrieve the relative X coordinate for a given observation point

Parameters:: oID (int) – Observation point ID (0, … )
Returns:: The obs’s X coordinate (single precision) Physical unit is [m] Indexing starts at 0
Return type:: float

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getXOfObsId_f()

getY(node)

Retrieve the Y coordinate of a node relative to the origin

Parameters:: node (int) – Node number
Returns:: The node’s Y coordinate Physical unit is [m] Indexing starts at 0
Return type:: float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getYOfObsId(oID)

Retrieve the relative Y coordinate for a given observation point

Parameters:

oID (int) – Observation point ID (0, … )

Returns:

The obs’s Y coordinate (single precision)
Physical unit is [m] Indexing starts at 0

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getYOfObsId_f()

getZ(node)

Retrieve the Z coordinate of a node relative to the origin

Parameters:

node (int) – Node number

Returns:

The node’s Z coordinate
Physical unit is [m] Indexing starts at 0

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

getZOfObsId(oID)

Retrieve the relative Z coordinate for a given observation point

Parameters:: oID (int) – Observation point ID (0, … )
Returns:: The obs’s Z coordinate (single precision) Physical unit is [m] Indexing starts at 0
Return type:: float

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

getZOfObsId_f()

getZValueAtXYSlice(x, z, slc)

Retrieve the Z coordinate of a location on a slice IfmGetZValueAtXYSlice() interpolates the elevation of a location on a slice based on its neighbor nodes. If the location is outside of the FEM mesh domain, a flag is returned.

Parameters:

x (float) – Location X coordinate
y (float) – Location Y coordinate
slc (int) – Slice (0 = first slice)

Returns:

The location’s Z coordinate
Physical unit is [m]

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

integrateNodalQuantitiesOfElement(nElem, p)

Returns the integral of nodal values ‘p’ over an element at simulation time.

Parameters:

nElem (int) – Element number
p ([float]) – Array of nodal values with length number of nodes per element

Returns:

integrated nodal quantity

Return type:

float

See also

getTotalContent, getElementalContent, getTotalContent2, getElementalContent2, integrateNodalQuantitiesOfElement

isBccFlowSet(constraint_type, node)

Returns TRUE if a flow constraint at the node ‘node’ is set

Parameters:

node (int) – node index
constraint_type ({ifm.Enum.MIN_BCC_TYPE, ifm.Enum.MAX_BCC_TYPE}) – constraint type

Returns:

Returns TRUE if a flow constraint at the node node is set set to the following type ‘typeBcc’

Return type:

bool

See also

isBccHeatSet(constraint_type, node)

Returns TRUE if a heat constraint at the node ‘node’ is set

Parameters:

node (int) – node index
constraint_type ({ifm.Enum.MIN_BCC_TYPE, ifm.Enum.MAX_BCC_TYPE}) – constraint type

Returns:

Returns TRUE if a heat constraint at the node node is set set to the following type ‘typeBcc’: - ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint - ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint - ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint - ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint

Return type:

bool

See also

isBccMassSet(constraint_type, node)

Returns TRUE if a mass constraint at the node ‘node’ is set

Parameters:

node (int) – node index
constraint_type ({ifm.Enum.MIN_BCC_TYPE, ifm.Enum.MAX_BCC_TYPE}) – constraint type

Returns:

Returns TRUE if a mass constraint at the node node is set set to the following type ‘typeBcc’: - ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint - ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint - ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint - ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint

Return type:

bool

See also

isDivergenceFormTransport()

IsDivergenceFormTransport: Not applicable for pure flow problems Returns a flag indicating the type formulation of transport equation(s)

Returns:: Returns TRUE if Divergence Form of transport equation(s), mass or/and heat, is set, otherwise, FALSE indicates the standard Convective Form of transport eqaution(s).
Return type:: bool

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

isExteriorBorder(border_index)

Returns a flag indicating the border orientation

Parameters:: border_index (int) – border index
Returns:: Returns TRUE if the border nBorder is an exterior border. Exterior borders have always a mathematically positive (counter clock wise) orientation whereas interior borders have a negative orientation (clock wise).
Return type:: bool

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

isMatConductivityTensor3DEnabled()

Test whether the conductivity anisotropy tensor for finite elements is applied

Returns:: TRUE if conductivity anisotropy tensors are applied, otherwise FALSE.
Return type:: bool

See also

isMultiLayerWellAttrTransient(mlw_id, mlw_attr)

Check for transient multilayer well attributes

Parameters:

mlw_id (int) – Node independent ID (index) of the multilayer well
mlw_attr (IfmMLW_ATTR) – Multi-layer well attribute

Returns:

True if the attribute is transient in time False if the attribute is constant over time

Return type:

bool

See also

isMultiLayerWellAttrValid(mlw_id, mlw_attr)

Check if multilayer well attribute is valid in the current context

Parameters:

mlw_id (int) – Node independent ID (index) of the multilayer well
mlw_attr (IfmMLW_ATTR) – Multi-layer well attribute

Returns:

True if the attribute is actually valid False if the attribute is not valid in the current FEM context

Return type:

bool

See also

isNodeInGroup(node, gID)

Retrieve a flag for identifying whether a node belongs to an observation group (legacy)

Parameters:

node (int) – Node number
gID (int) – Group ID

Returns:

The flag identifier
if -1 the group ID is not valid
if 0 the node does not belong to the group
if 1 the node belongs to the group ID
Indexing starts with 0.

See also

getNumberOfValidGroups, getMaximumNumberOfGroups, isNodeInGroup, getFlowValueOfGroupIdAtCurrentTime, getMassValueOfGroupIdAtCurrentTime, getHeatValueOfGroupIdAtCurrentTime

isVelocityFieldPresent()

Check if velocity field is present.

Returns:: True if velocity field is present, False otherwise.
Return type:: bool

loadTimeStep(int)

Load a time step from the current DAC file.

Parameters:: file_index (int) – The time step index in the file.
Returns:: True if time step was loaded successfully, False otherwise
Return type:: bool

Note

file_index denotes the n’th time step stored in the dac-file. This will differ from the time step number if not all time steps are saved in the dac file.

meshSmoothing(int)

Smooths the finite element mesh by using Laplacian operator on hydraulic head distribution

Parameters:: int – Laplacian smoothing operator on distribution vector: - ifm.Enum.SMOOTH_DEFAULT (0) = no distribution (default) - ifm.Enum.SMOOTH_BY_HEAD (1) = hydraulic head distribution - ifm.Enum.SMOOTH_BY_MASS (2) = species mass distribution - ifm.Enum.SMOOTH_BY_HEAT (3) = temperatur distribution
Returns:: True if smooting was successful, False if failed
Return type:: bool

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

parseUserMetaData()

Parse a string containing User Meta Information.

Parameters:: xml_string – User Meta Information as XML string.

See also

getMetaData, getUserMetaData, setUserMetaData

pauseSimulator(): Pause the simulator during simulation run.

powerCreateCurve(ts_id)

Creates a new POWER function with the given <id>. If the POWER function already exists no new power function will be createdand the input id is returned instead. If zero (0) is passed, the function creates a POWER function with the lowest free POWER function ID.

Parameters:: ts_id (int) – Id of new time series
Returns:: The ID of the created POWER function on success or zero on failure.
Return type:: int

powerDeleteCurve(ts_id)

Deletes an existing POWER function. powerDeleteCurve() attempts to delete the POWER function associated with id. If the POWER function is currently in use (busy) the function will fail.

Parameters:: ts_id (int) – Id of new time series

powerDeletePoint(ts_id, pid)

Delete a Point from a Time Series.

Parameters:

ts_id (int) – id of time series
pid (int) – id of point

powerEnableRecording(ts_id, enable)

Enable or disable recording of power function curve points to DAC file.

Parameters:

ts_id (int) – time series id
enable (bool) – if True, recording will be set active for given time series (inactive otherwise)

Returns:

Previous value of the flag.

Return type:

bool

See also

getPowerCurve, createPowerCurve, deletePowerCurve, findPowerCurve, getPowerInterpolationKind, setPowerInterpolationKind, isPowerCyclic, setPowerCyclic, getPowerComment, setPowerComment, getNumberOfPowerPoints, getPowerPoint, setPowerPoint, deletePowerPoint, interpolatePowerValue, powerEnableRecording

powerFindCurve(comment)

Find a POWER function by its comment. powerFindCurve() can be used to find the POWER function identified by its comment string.

Parameters:: comment (str) – comment of the curve to fine
Returns:: POWER function identifier (ID)
Return type:: int

powerGetComment(ts_id)

Retrieve the POWER function comment. By using IfmGetPowerComment(), the comment associated with the power function can be obtained. It is useful for visualizaton in diagrams etc.

Parameters:: ts_id (int) – id of the time series
Returns:: The comment associated with the POWER function.
Return type:: str

powerGetCurve(ts_id)

Get the ID of the next POWER function. powerGetCurve() searches the next POWER function with an ID greater than <powid_start>. To get the first POWER function, pass zero (0) as powid_start.

Parameters:: ts_id (int) – id of the time series
Returns:: The ID of the next POWER function or -1 if no more POWER functions exist.
Return type:: int

powerGetCurves()

Get a list of all POWER function IDs.

Returns:: list of all POWER function IDs in the model
Return type:: list

powerGetInterpolationKind(ts_id)

Get the time of interpolation of a time series.

Parameters:: ts_id (int) – id of the time series
Returns:: interpolation kind
Return type:: {ifm.Enum.INTERPOL_DEFAULT, ifm.Enum.INTERPOL_CONST, ifm.Enum.INTERPOL_LINEAR, ifm.Enum.INTERPOL_AKIMA, ifm.Enum.INTERPOL_AKIMA2}

powerGetNumberOfPoints(ts_id)

Get number of points of a time series.

Parameters:: ts_id (int) – ID of a time series
Returns:: number of points
Return type:: int

powerGetPoint(ts_id, point_id)

Get a Point from a time seroes

Parameters:

ts_id (int) – time series ID
point_id (int) – point index

Returns:

tuple (time, value) pair of the power point

Return type:

(float, float)

powerInterpolateValue(ts_id, time)

Get the value of a time series interpolated at given time

Parameters:

ts_id (int) – time series ID
time (float) – time to return value for

Returns:

interpolated value

Return type:

float

powerIsCyclic(ts_id)

Test if a time series is cyclic

Parameters:: ts_id (int) – time series ID
Returns:: True if time series is cyclic
Return type:: bool

powerSetComment(ts_id, comment)

Sets the time series comment.

Parameters:

ts_id (int) – Time Series ID
comment (str) – Time Series Comment (Name)

powerSetCyclic(ts_id, cyclic)

Set if the time mode of the time series is cyclic or not (single-pass)

Parameters:

ts_id (int) – Time Series ID
cyclic (bool) – True if cyclic (repeating), False if on-cyclic (single-pass)

powerSetInterpolationKind(id, kind)

Set the interpolation kind of a POWER function.

ifm.Enum.INTERPOL_CONST(1): No interpolation - constant from point to point
ifm.Enum.INTERPOL_LINEAR(2): Linear interpolation between points
ifm.Enum.INTERPOL_AKIMA(3): AKIMA interpolation
ifm.Enum.INTERPOL_AKIMA(4): AKIMA interpolation (smoother)

Parameters:

id (int) – Time Series ID
kind (int) – Interpolation Kind

powerSetPoint(ts_id, time, value)

Set the time and value of a point in a time series

Parameters:

ts_id (int) – time series id
time (float) – time and value of point
value (float) – time and value of point

queryCustomTimes()

Use this function to obtain a list of custom times which will be navigated to by the adaptive time steppping control.

Returns:: list of time steps Physical unit is [d]
Return type:: tuple([float], int)

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

queryEdgeElements(iEdge)

Query for finite elements attached to an edge.

Parameters:: iEdge (int) – Edge index (0-based)
Returns:: Array of element indices
Return type:: [int]

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

queryEdgeNodes(edge_id)

Get the node numbers of a given element edge.

Parameters:: edge_id (int) – id of the edge
Returns:: list of node indices
Return type:: [int]

queryFaceElements(iFace)

Fetch elements attached to a finite element face

Parameters:: iFace (int) – Faceindex
Returns:: Array of element indices
Return type:: [int]

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

queryFaceNodes(face_id)

Get the list of nodes of a given element face

Parameters:: face_id (int) – id of the element face
Returns:: list of nodes
Return type:: [int]

queryMultiLayerWellInfo(node)

Query information about multilayer well at a given node

Parameters:: node (int) – Bottom node number of the MLW [0…np]
Returns:: Multi-layer well info structure, all members initialized by 0 but size member by sizeof this structure
Return type:: ifm.MLWInfo

See also

releaseParameter(parameter)

The function releases the parameter handle retrieved by IfmGetParameter().

Parameters:: parameter ({int,[int,string]}) – The parameter to be released.

See also

runTo(final_time)

Run simulation up to a given absolute simulation time.

Parameters:: final_time (float) – the absolute simulation time in days to run to.
Returns:: True if the simulation’s final time is reached, otherwise False. If finalTime is less or equal to the current simulation time the function returns immediately. If finalTime is greater than the simulation’s final time the functions runs up to this time and returns True
Return type:: bool

saveDocument(filename[, time-step list[, file version[, file type]]])

selectionItemIsSet(nSelType, nSelIndex, nItem)

Test an item’s state in a selection Returns true if the item can be found in the selection otherwise false.

Parameters:

nSelType (IfmSEL_TYPE) – Selection type
nSelIndex (int) – Selection index
nItem (int) – Item to to test

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

setAMRErrorTolerance(tolerance)

Set the AMR Error Tolerance

Parameters:: tolerance (float) – AMR error tolerance

setAMREstimatorType(EstimatorType)

Set the of Adaptive Mesh Refinement (AMR) error estimator type Possible arguments for EstimatorType are:

ifm.Enum.AMR_ONATE_AND_BUGEDA (0) = Onate and Bugeda (1994)uing)
ifm.Enum.AMR_ZIENKIEWICZ_AND_ZHU (1) = Zienkiewicz and Zhu (1987-1990)
ifm.Enum.AMR_UNSPECIFIED (2) = unspecified AMR method (used by IFM calls)

Parameters:: EstimatorType (int) – Error estimator type to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setAMRType(AMRFlag)

Set the type of Adaptive Mesh Refinement (AMR) technique Possible arguments for AMRFlag are:

ifm.Enum.AMR_NO (0) = do not use AMR technique
ifm.Enum.AMR_DO (1) = perform AMR technique

Parameters:: AMRFlag (int) – AMR flag to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setAmrElementRefinement(nIndex, flag)

Mark an element for either refining or derefining IfmSetAmrElementRefinement() marks an element for refining (flag=ifm.Enum.AMR_REFINE), derefining (flag=ifm.Enum.AMR_DEREFINE), or unmarks the element when ifm.Enum.AMR_KEEP is passed as flag.

Parameters:

nIndex (int) – Element number to be marked
flag (IfmRefinement) – Flag: ifm.Enum.AMR_REFINE, ifm.Enum.AMR_DEREFINE, ifm.Enum.AMR_KEEP

See also

setAmrElementRefinement, getAmrElementRefinement, getAmrErrorTolerance, setAmrErrorTolerance

setBHEArrayFlowDischarge(bhe_index, value)

Set the flow discharge of BHE array [m3/d] at given index ‘bhe_index’

Parameters:

bhe_index (int) – Index of BHE array (index starts at 0)
value (float) – flow discharge [m3/d] of BHE array to be set

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

setBHEArrayInTemperature(bhe_index, value)

Set the in temperature of BHE array [oC] at given index ‘bhe_index’

Parameters:

bhe_index (int) – Index of BHE array (index starts at 0)
value (float) – Value in temperature [oC] of BHE array to be set

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

setBHEFlowDischarge(bhe_index, value)

Set the flow discharge of BHE [m3/d] at given index ‘nIndex’

Parameters:

bhe_index (int) – Index of BHE (index starts at 0)
value (float) – flow discharge [m3/d] of BHE to be set

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

setBHEHeatInputRate(bhe_index, value)

Set the heat input rate of BHE [J/d] at given index ‘nIndex’

Parameters:

bhe_index (int) – Index of BHE (index starts at 0)
value (float) – Heat input rate [J/d] of BHE to be set

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

setBHEInletTemperature(bhe_index, value)

Set the inlet temperature of BHE [oC] at given index ‘nIndex’

Parameters:

bhe_index (int) – Index of BHE (index starts at 0)
value (float) – Inlet temperature [oC] of BHE to be set

See also

getBHENumber, getBHEReferenceNode, getBHEHeatInputRate, getBHEInletTemperature, getBHEOutletTemperature, getBHEType, getBHEFlowDischarge, getReferenceTemperature, setBHEHeatInputRate, setBHEInletTemperature, setBHEFlowDischarge, resetBHE, getBHEArrayNumber, getBHEArrayName, getBHEArrayInTemperature, getBHEArrayOutTemperature, getBHEArrayFlowDischarge, setBHEArrayInTemperature, setBHEArrayFlowDischarge

setBcFlowTypeAndValueAtCurrentTime(node, bc_type, bc_unst, value)

Set (create) the flow boundary condition type and value at the current time

possible BC Types

ifm.Enum.BC_NONE (0) = no boundary condition (delete existing)
ifm.Enum.BC_DIRICHLET (1) = Dirichlet (1st kind)
ifm.Enum.BC_NEUMANN (2) = Neumann (2nd kind)
ifm.Enum.BC_CAUCHY (3) = Cauchy (3rd kind)
ifm.Enum.BC_SINGLE_WELL (4) = Single well (4th kind)
ifm.Enum.BC_GRADIENT_FTYPE (5) = Gradient-type

Parameters:

node (int) – Node number
bc_type ({0|1|2|3|4|5}) – type of BC to set
bc_unst ({0|1}) – transient state ( 0 - if steady-state (constant), 1 - if unsteady)
value (float) – Value to be set. If unsteady, value represents the power ID (an integer) of the time-dependent function, the power ID must be in a range available in the problem, if the power ID does not meet a valid number an error is echoed. if, steady-state the value is the constant boundary value assigned at the current time

Note

The value is related to the current simulation time.

See also

setBcFlowTypeAndValueAtCurrentTime2(node, bc_type, bc_unst, bc_spec, value)

Set (create) the flow boundary condition type, specification and value at the current time

possible BC Types

ifm.Enum.BC_NONE (0) = no boundary condition (delete existing)
ifm.Enum.BC_DIRICHLET (1) = Dirichlet (1st kind)
ifm.Enum.BC_NEUMANN (2) = Neumann (2nd kind)
ifm.Enum.BC_CAUCHY (3) = Cauchy (3rd kind)
ifm.Enum.BC_SINGLE_WELL (4) = Single well (4th kind)
ifm.Enum.BC_GRADIENT_FTYPE (5) = Gradient-type

Parameters:

node (int) – Node number
bc_type ({0|1|2|3|4|5}) – type of bc
bc_unst ({0|1}) – transient state ( 0 - if steady-state (constant), 1 - if unsteady)
bc_spec ({0|1}) – Specification to be set: ifm.Enum.NONINTEGRAL_BC (0) = non-integrated B.C. flux option ifm.Enum.INTEGRAL_BC (1) = integrated B.C. flux option
value (float) – Value to be set. If unsteady, value represents the power ID (an integer) of the time-dependent function, the power ID must be in a range available in the problem, if the power ID does not meet a valid number an error is echoed. if, steady-state the value is the constant boundary value assigned at the current time

See also

setBcFlowValueAtCurrentTime(node, value)

Set the flow boundary condition value at the current time

Parameters:

node (int) – Node number
value (float) – Value to be set

Notes

The value is related to the current simulation time. Indexing starts with 0.

See also

setBcFlowValueOfGroupIdAtCurrentTime(gID, nValue)

Set the flow boundary condition value at the current time for all nodes covering a given group ID

Parameters:

gID (int) – Group ID
value (float) – Value to be set

Notes

The value is related to the current simulation time. Indexing starts with 0.

See also

setBcHeatTypeAndValueAtCurrentTime(node, bctype, bcUnst, value)

Set (create) the heat boundary condition type and value at the current time

ifm.Enum.BC_NONE (0) = no boundary condition (delete BC)
ifm.Enum.BC_DIRICHLET (1) = Dirichlet (1st kind)
ifm.Enum.BC_NEUMANN (2) = Neumann (2nd kind)
ifm.Enum.BC_CAUCHY (3) = Cauchy (3rd kind)
ifm.Enum.BC_SINGLE_WELL (4) = Single well (4th kind)
ifm.Enum.BC_GRADIENT_FTYPE (5) = Gradient-type

Parameters:

node (int) – Node number
bctype ({0,1,2,3,4,5}) – type if boundary condition
bcUnst (int) – 1 - if unsteady, 0 - if steady-state (constant)
value (float) – Value to be set: if bcUnst == 1 (i.e., unsteady) the nValue represents the power ID (an integer) of the time-dependent function, the power ID must be in a range available in the problem, if the power ID does not meet a valid number an error is echoed; if bcUnst == 0 (i.e., steady-state) the nValue is the constant boundary value assigned at the current time

See also

setBcHeatTypeAndValueAtCurrentTime2(node, bctype, bcUnst, bcSpec, value)

Set (create) the heat boundary condition type, specification and value at the current time

ifm.Enum.BC_NONE (0) = no boundary condition (delete BC)
ifm.Enum.BC_DIRICHLET (1) = Dirichlet (1st kind)
ifm.Enum.BC_NEUMANN (2) = Neumann (2nd kind)
ifm.Enum.BC_CAUCHY (3) = Cauchy (3rd kind)
ifm.Enum.BC_SINGLE_WELL (4) = Single well (4th kind)
ifm.Enum.BC_GRADIENT_FTYPE (5) = Gradient-type

Parameters:

node (int) – Node number
bctype ({0,1,2,3,4,5}) – type if boundary condition
bcUnst (int) – 1 - if unsteady, 0 - if steady-state (constant)
bcSpec (int) – specification to be set: ifm.Enum.NONINTEGRAL_BC (0) = non-integrated B.C. flux option ifm.Enum.INTEGRAL_BC (1) = integrated B.C. flux option
value (float) – Value to be set: if bcUnst == 1 (i.e., unsteady) the nValue represents the power ID (an integer) of the time-dependent function, the power ID must be in a range available in the problem, if the power ID does not meet a valid number an error is echoed; if bcUnst == 0 (i.e., steady-state) the nValue is the constant boundary value assigned at the current time

Notes

See also

setBcHeatValueAtCurrentTime(node, value)

Set the heat boundary condition value at the current time

Parameters:

node (int) – Node number
value (float) – Value to be set

Notes

The value is related to the current simulation time. Indexing starts with 0.

See also

setBcHeatValueOfGroupIdAtCurrentTime(gID, nValue)

Set the heat boundary condition value at the current time for all nodes covering a given group ID

Parameters:

gID (int) – Group ID
value (float) – Value to be set

Notes

The value is related to the current simulation time. Indexing starts with 0.

See also

setBcMassTypeAndValueAtCurrentTime(node, bcType, bcUnst, value)

Set (create) the mass boundary condition type and value at the current time

ifm.Enum.BC_NONE (0) = no boundary condition
ifm.Enum.BC_DIRICHLET (1) = Dirichlet (1st kind)
ifm.Enum.BC_NEUMANN (2) = Neumann (2nd kind)
ifm.Enum.BC_CAUCHY (3) = Cauchy (3rd kind)
ifm.Enum.BC_SINGLE_WELL (4) = Single well (4th kind)
ifm.Enum.BC_GRADIENT_FTYPE (5) = Gradient-type

Parameters:

node (int) – Node number
bcType (int) – type of boundary condition
bcUnst (int) – 1 - if unsteady, 0 - if steady-state (constant)
value (float) – value to be set. if bcUnst == 1 (i.e., unsteady) the nValue represents the power ID (an integer) of the time-dependent function, the power ID must be in a range available in the problem, if the power ID does not meet a valid number an error is echoed; if bcUnst == 0 (i.e., steady-state) the nValue is the constant boundary value assigned at the current time

Notes

See also

setBcMassTypeAndValueAtCurrentTime2(node, bcType, bcUnst, bcSpec, value)

Set (create) the mass boundary condition type and value at the current time

ifm.Enum.BC_NONE (0) = no boundary condition
ifm.Enum.BC_DIRICHLET (1) = Dirichlet (1st kind)
ifm.Enum.BC_NEUMANN (2) = Neumann (2nd kind)
ifm.Enum.BC_CAUCHY (3) = Cauchy (3rd kind)
ifm.Enum.BC_SINGLE_WELL (4) = Single well (4th kind)
ifm.Enum.BC_GRADIENT_FTYPE (5) = Gradient-type

Parameters:

node (int) – Node number
bcType (int) – type of boundary condition
bcUnst (int) – 1 - if unsteady, 0 - if steady-state (constant)
bcSpec (int) – Specification to be set: ifm.Enum.NONINTEGRAL_BC (0) = non-integrated B.C. flux option ifm.Enum.INTEGRAL_BC (1) = integrated B.C. flux option
value (float) – value to be set. if bcUnst == 1 (i.e., unsteady) the nValue represents the power ID (an integer) of the time-dependent function, the power ID must be in a range available in the problem, if the power ID does not meet a valid number an error is echoed; if bcUnst == 0 (i.e., steady-state) the nValue is the constant boundary value assigned at the current time

See also

setBcMassValueAtCurrentTime(node, value)

Set the mass boundary condition value at the current time

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setBcMassValueOfGroupIdAtCurrentTime(gID, value)

Set the mass boundary condition value at the current time for all nodes covering a given group ID

Parameters:

gID (int) – Group ID
value (float) – Value to be set

Notes

The value is related to the current simulation time. Indexing starts with 0.

See also

setBcMoistureContentValueAtCurrentTime(node, value)

Set (create) a 1st kind flow boundary condition type by describing a moisture content value at current time (useful for unsaturated problems)

Parameters:

node (int) – Node number
value (float) – Value of moisture content [1] to be set

Notes

The moisture content value has the physical unit [1] and is related to the current simulation time Indexing starts with 0.

See also

setBcPressureValueAtCurrentTime(node, value)

Set (create) a 1st kind flow boundary condition type by describing a pressure value at current time

Parameters:

node (int) – Node number
value (float) – Value of pressure [kPa] to be set

Notes

The pressure value has the physical unit [kPa] and is related to the current simulation time Indexing starts with 0.

See also

setBcSaturationValueAtCurrentTime(node, value)

Set (create) a 1st kind flow boundary condition type by describing a saturation value at current time (useful for unsaturated problems)

Parameters:

node (int) – Node number
value (float) – Value of saturation [1] to be set

Notes

The saturation value has the physical unit [1] and is related to the current simulation time Indexing starts with 0.

See also

setBcSeepageFaceAtCurrentTime(node)

Set (create) a 1st kind flow boundary condition type by describing a seepage face condition at current time Indexing starts with 0.

Parameters:: node (int) – Node number

See also

setBccFlowTypeAndValueAtCurrentTime(node, bccType, bccUnst, value, bcc_constraint)

Set (create) the flow boundary constraint type and value at the current time

ifm.Enum.BCC_NONE (0) = no constraint
ifm.Enum.BCC_DIRICHLET (1) = Dirichlet constraint
ifm.Enum.BCC_NEUMANN (2) = Neumann constraint
ifm.Enum.BCC_CAUCHY (3) = Cauchy constraint
ifm.Enum.BCC_SINGLE_WELL (4) = Single well constraint
ifm.Enum.BCC_SPECIAL_3RD_BCC (6) = Special 3rd kind flow head B.C.’s constraint

Parameters:

node (int) – Node number
bccType (int) – Flow B.C.C. type
bccUnst (int) – 1 - if unsteady, 0 - if steady-state (constant)
value (float) – value to be set: if bccUnst == 1 (i.e., unsteady) the nValue represents the power ID (an integer) of the time-dependent function, the power ID must be in a range available in the problem, if the power ID does not meet a valid number an error is echoed; if bccUnst == 0 (i.e., steady-state) the nValue is the constant boundary value assigned at the current time
bcc_constraint (int) – contstraint flag ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport) ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

Notes

See also

setBccFlowValueAtCurrentTime(node, value, typeBcc)

Set the flow boundary constraint value at the current time

Parameters:

node (int) – Node number
value (float) – Value to be set
typeBcc (int) – Constraint flag ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport) ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

See also

setBccFlowValueOfGroupIdAtCurrentTime(gID, value, typeBcc)

Set the flow boundary constraint value at the current time for all nodes covering a given group ID

Parameters:

gID (int) – Group ID
value (float) – Value to be set
typeBcc (int) – Constraint flag: ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport) ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

See also

setBccHeatTypeAndValueAtCurrentTime(node, value, typeBcc)

Set (create) the heat boundary constraint type and value at the current time

Parameters:

node (int) – Node number
value (float) – Value to be set
typeBcc (int) – Constraint flag ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport) ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

See also

setBccHeatValueAtCurrentTime(node, value, typeBcc)

Set the heat boundary constraint value at the current time

Parameters:

node (int) – Node number
value (float) – Value to be set
typeBcc (int) – Constraint flag: ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport) ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

Notes

See also

setBccHeatValueOfGroupIdAtCurrentTime(gID, value, typeBcc)

Set the heat boundary constraint value at the current time for all nodes covering a given group ID

Parameters:

gID (int) – Group ID
value (float) – Value to be set
typeBcc (int) – Constraint flag: ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport) ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

See also

setBccMassTypeAndValueAtCurrentTime(node, value, typeBcc)

Set (create) the mass boundary constraint type and value at the current time

Parameters:

node (int) – Node number
value (float) – Value to be set
typeBcc (int) – Constraint flag ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport) ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

See also

setBccMassValueAtCurrentTime(node, value, typeBcc)

Set the mass boundary constraint value at the current time

Parameters:

node (int) – Node number
value (float) – Value to be set
typeBcc (int) – Constraint flag: ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport) ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

Notes

See also

setBccMassValueOfGroupIdAtCurrentTime(gID, value, typeBcc)

Set the mass boundary constraint value at the current time for all nodes covering a given group ID

Parameters:

gID (int) – Group ID
value (float) – Value to be set
typeBcc (int) – Constraint flag ifm.Enum.MIN_BCC_TYPE (0) - Minimum constraint ifm.Enum.MAX_BCC_TYPE (1) - Maximum constraint ifm.Enum.HMIN_BCC_TYPE (2) - Head minimum constraint (for transport) ifm.Enum.HMAX_BCC_TYPE (3) - Head maximum constraint (for transport)

See also

setCoupledHeatTransBndNodes(nodes, tref_values, phi_values)

Sets Nodal Heat-Transfer Boundary conditions (Cauchy-Type, 3rd kind) at the nodes given by ‘nodes’.

Note: this is a special type of boundary condition, which is currently only accessible through the IFM API. A nodal transfer BC set in this way will appear as a normal Cauchy BC in the GUI.

This function sets a special boundary condition of a specific exchange type in the form Q = - PHI*(T - Tref) at single FEFLOW nodes with given indices, where Q [J/d] is the heat flux to be computed at the single node (similar to a pumping well), PHI [J/d/C] is the transfer coefficient to be assigned at the node, T [C] is the temperature of groundwater to be computed by FEFLOW and Tref [C] is the reference temperature to be assigned at the node.

The transfer coefficient PHI represents the heat transfer and the exchange area between the surroundings and groundwater. Note that there is no difference between outflux and influx transfer coefficient (needs to be handled by the code if applicable)

Parameters:

nodes ([int]) – list of nodal indices of nodes to best
tref_values ([float]) – reference temperature values [C]
temp_trans_coeffs ([float]) – nodal heat transfer-rate values [J/d/C]

See also

setCoupledMassTransBndNodes(nodes, coref_values, phi_values)

Sets Nodal Mass-Transfer Boundary conditions (Cauchy-Type, 3rd kind) at the nodes given by ‘nodes’.

Note: this is a special type of boundary condition, which is currently only accessible through the IFM API. A nodal transfer BC set in this way will appear as a normal Cauchy BC in the GUI.

Sets special boundary conditions at given nodes for mass transfer (e.g., used for leaching) according to the relationship

Q = - PHI(C - Cref)

Physical units are PHI [m3/d] and Cref [mg/l]

This function sets a special boundary condition of a specific exchange type in the form Q = - PHI*(C - Cref) at single FEFLOW nodes with given indices, where Q [m3/d * mg/l] is the mass flux to be computed at the single node (similar to a pumping well), PHI [m3/d] is the transfer coefficient to be assigned at the node, C [mg/l] is the concentration of groundwater to be computed by FEFLOW and Cref [mg/l] is the reference concentration to be assigned at the node.

The transfer coefficient PHI to represent the leakage and the exchange area between the surroundings and groundwater. Note that there is no difference between outflux and influx transfer coefficient (needs to be handled by the code if applicable).

Parameters:

nodes ([int]) – Vector of nodal numbers of river nodes
cref_values ([float]) – reference concentration values [mg/l]
phi_values ([float]) – nodal mass-transfer rate values [m3/d]

See also

setCoupledRiverBndNodes(nodes, href_values, phi_values)

Sets Nodal Fluid-Transfer Boundary conditions (Cauchy-Type, 3rd kind) at the nodes given by ‘nodes’.

Note: this is a special type of boundary condition, which is currently only accessible through the IFM API. A nodal transfer BC set in this way will appear as a normal Cauchy BC in the GUI.

This type of BC is useful to describe groundwater - surface water flow exchange with rivers according to the relationship

Q = - PHI(h - h_ref)

where the wetted perimeter of the river shall be calculated outside of FEFLOW and shall be unrelated to the mesh geometry.

This function sets a special boundary condition of a specific exchange type in the form Q = - PHI(h - h_ref) at single FEFLOW nodes with given indices, where Q [m3/d] is the discharge to be computed at the single node (similar to a pumping well), PHI [m2/d] is the transfer coefficient to be assigned at the node, h [m] is the hydraulic head of groundwater to be computed by FEFLOW and h_ref [m] is the hydraulic head of the river (surface water) to be assigned at the node. The user has to be described to parameters: the surface water (reference) level Hsurf and the transfer coefficient PHI to represent the leakage and the exchange area between the surface water and groundwater.

This coefficient PHI is the product of the wetted area of the coupled surface water branch which is represented by this node and a transfer rate representing the outflow-inflow resistance between surface water and groundwater. Note that there is no difference between outflow and inflow transfer coefficient. However, different PHI can be easily taken into consideration by the user if specifying the coefficient in dependence on the actual difference of (H-Hsurf) at any simulation time. Note further that this function of special ‘exchange-type’ well-BC is not visible as symbolics in any way in FEFLOW.

Parameters:

nodes ([int]) – Vector of nodal numbers of river nodes
href_values ([float]) – reference head values at rives nodes [m]
phi_values ([float]) – PHI values at rives nodes [m2/d]

See also

setCustomTimes()

setCustomTimes(list of double[, int]

Set custom simulation times

Use this function to set the array of custom times which will be navigated to by the adaptive time steppping control.

Parameters:

arTimes (str) – Array of custom (additional) times [in]
nTimes (int) – Length of arTimes [in]
nFlags (int) – Target flags: IfmCUSTOMSTEPS_ALL|IfmCUSTOMSTEPS_OUTPUT|IfmCUSTOMSTEPS_SIMUL

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

setDiagramBudgetMode(selection, mode)

Set budget diagram mode

IfmSetDiagramBudgetMode() sets the budget mode of the nodal selection with index nSelIndex. This setting affects the curves displayed in budget diagrams. Refer to Ifm.Enum.DGR_BUDGET_ID for possible budget mode ids

Parameters:

selection ({int|string}) – Selection index or name
mode (nId) – diagram mode

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

setDiagramContentType()

setDiagramContentType({int|string}, int

Set content type id displayed in content diagrams

IfmSetDiagramContentType() sets the content type of the elemental selection identified by index nSelIndex. This setting affects the curves displayed in content diagrams. Refer to IfmDGR_CONTENT_ID for possible content type ids

Parameters:

nSelIndex (int) – Selection index
type (int) – diagram content type

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

setElementalRefDistrValue(rID, element, value)

Set the value of element element in elemental reference distribution with id rID

Parameters:

rID (long) – Elemental reference distribution ID [0, … ]
element (long) – Element index [0 … ne_3d]
value (float) – Value to be set as property at the node

Return type:

No return value.

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

setElementalRefDistrValues(int distr_id, double[] values[, int start = 0[, int count = len(values)]])

Sets multiple values of a reference distribution addressed by id and range

Parameters:

distr_id (int) – User Distribution ID
values ([float] or float) – Values to set. User either a list of length n_nodes or a single value.
start (int, optional) – Node index to start writing new values
count (int, optional) – number of values to write

Examples

>>> doc.setElementalRefDistrValues(3, 0.001)
>>> doc.setElementalRefDistrValues(4, [0.1, 0.2, 0.3], 100)

setEquationSolvingType(EQSOLVFlag)

Set the type of equation solving Possible arguments for EQSOLVFlag are:

ifm.Enum.EQSOLV_ITERAT (0) = iterative equation solving
ifm.Enum.EQSOLV_DIRECT (1) = direct equation solving

Parameters:: EQSOLVFlag (int) – EQSOLV flag to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setFinalSimulationTime(tend)

Set the final simulation time (tend > 0.)

Parameters:

tend (float) – Final time stage [d]

Returns:

The final simulation time (tend > 0.)
Physical unit is [d]

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

setFlowAnisotropy(anisotropy_type)

Sets the anisotropy type of the model.

Parameters:: anisotropy_type (int) – the anisotropy type

setFracArea(nFracElement, value, FracType, FracMode, FracLaw)

Set the geometric aperture or area of a fracture element for given type, mode and law

Following fracture types can be specified: - ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed - ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element - ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element - ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: - ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed - ifm.Enum.FRAC_H (0) = horizontal fracture selection mode - ifm.Enum.FRAC_V (1) = vertical fracture selection mode - ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: - ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed - ifm.Enum.DARCY_LAW (0) = Darcy flow - ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow - ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [m] for aperture or [m2] for area

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value (aperture or area) to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracFlowCompressibility(nFracElement, value, FracType, FracMode, FracLaw)

Set the compressibility of fracture element for given type, mode and law

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1/m]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracFlowConductivity(nFracElement, value, FracType, FracMode, FracLaw)

Set the hydr. conductivity, hydr. aperture or roughness coeff. for given type, mode and law

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [m/d] (Darcy), [m] (Hagen-Poiseuielle) or [m0.333/d] (Manning-Strickler)

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracFlowDensityRatio(nFracElement, value, FracType, FracMode, FracLaw)

Set the density ratio for density-coupled problems of fracture element for given type, mode and law

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracFlowExpansionCoeff(nFracElement, value, FracType, FracMode, FracLaw)

Set the volumetric expansion coefficient for thermally density-coupled problems of fracture element for given type, mode and law

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1/K]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracFlowSinkSource(nFracElement, value, FracType, FracMode, FracLaw)

Set the sink/source parameter of fracture element for given type, mode and law

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1/d]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracFlowStorativity(nFracElement, value, FracType, FracMode, FracLaw)

Set the storativity of fracture element for given type, mode and law

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracFlowTransferIn(nFracElement, value, FracType, FracMode, FracLaw)

Set the transfer rate for inflow of a flow problem of fracture element for given type, mode and law

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1/d]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracFlowTransferOut(nFracElement, value, FracType, FracMode, FracLaw)

Set the transfer rate for outflow of a flow problem of fracture element for given type, mode and law

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1/d]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatFluidCapacity(nFracElement, value, FracType, FracMode, FracLaw)

Set the volumetric heat capacity of fluid for a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [J/m3/K]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatFluidConductivity(nFracElement, value, FracType, FracMode, FracLaw)

Set the heat conductivity of fluid for a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [J/m/d/K]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatFluidSinkSource(nFracElement, value, FracType, FracMode, FracLaw)

Set the heat source/sink of fluid for a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [J/m3/d]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatLongDispersivity(nFracElement, value, FracType, FracMode, FracLaw)

Set the longitudinal dispersivity for a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [m].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatPorosity(nFracElement, value, FracType, FracMode, FracLaw)

Set the kinematic porosity applied to a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatSolidCapacity(nFracElement, value, FracType, FracMode, FracLaw)

Set the volumetric heat capacity of solid for a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [J/m3/K].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatSolidConductivity(nFracElement, value, FracType, FracMode, FracLaw)

Set the heat conductivity of solid for a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [J/m/d/K].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatSolidSinkSource(nFracElement, value, FracType, FracMode, FracLaw)

Set the heat source/sink of solid for a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [J/m3/d]

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatTransDispersivity(nFracElement, value, FracType, FracMode, FracLaw)

Set the transverse dispersivity for a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [m].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatTransferIn(nFracElement, value, FracType, FracMode, FracLaw)

Set the transfer rate for influx of a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [J/m2/d/K].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracHeatTransferOut(nFracElement, value, FracType, FracMode, FracLaw)

Set the transfer rate for outflux of a heat transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [J/m2/d/K].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracLaw(nFracElement, FracType, FracMode, FracLaw)

Sets the fluid flow law of a fracture element for given type, mode and law: ifm.Enum.ALL_FRAC_LAWS = -1 All fracture flow laws ifm.Enum.DARCY_LAW = 0 Darcy flow equation ifm.Enum.HP_LAW = 1 Hagen-Poiseuille flow equation ifm.Enum.MANNING_LAW = 2 Manning-Strickler flow equation

Parameters:

nFracElem (int) – Element number (0 based)
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracMassDecayRate(nFracElement, value, FracType, FracMode, FracLaw)

Set the decay rate applied to a mass transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1/d].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracMassDiffusion(nFracElement, value, FracType, FracMode, FracLaw)

Set the molecular diffusion applied to a mass transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [m2/d].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracMassLongDispersivity(nFracElement, value, FracType, FracMode, FracLaw)

Set the longitudinal dispersivity applied to a mass transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [m].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracMassPorosity(nFracElement, value, FracType, FracMode, FracLaw)

Set the kinematic porosity applied to a mass transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracMassSinkSource(nFracElement, value, FracType, FracMode, FracLaw)

Set the sink/source applied to a mass transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [g/m3/d].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracMassSorptionCoeff(nFracElement, value, FracType, FracMode, FracLaw)

Set the sorption coefficient applied to a mass transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [1].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracMassTransDispersivity(nFracElement, value, FracType, FracMode, FracLaw)

Set the transverse dispersivity applied to a mass transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [m].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracMassTransferIn(nFracElement, value, FracType, FracMode, FracLaw)

Set the transfer rate for influx of a mass transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [m/d].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setFracMassTransferOut(nFracElement, value, FracType, FracMode, FracLaw)

Set the transfer rate for outflux of a mass transport problem for given type, mode and law of fractures

Following fracture types can be specified: ifm.Enum.ALL_FRAC_TYPES (-1) = all types are allowed ifm.Enum.FRAC_1D (0) = 1D (bar) fracture element ifm.Enum.FRAC_2D_TRI (1) = 2D triangular fracture element ifm.Enum.FRAC_2D_QUA (2) = 2D quadrilateral fracture element

Following fracture selection modes can be specified: ifm.Enum.ALL_FRAC_MODES (-1) = all modes are allowed ifm.Enum.FRAC_H (0) = horizontal fracture selection mode ifm.Enum.FRAC_V (1) = vertical fracture selection mode ifm.Enum.FRAC_A (2) = arbitrary fracture selection mode

Following fracture flow laws can be specified: ifm.Enum.ALL_FRAC_LAWS (-1) = all flow laws are allowed ifm.Enum.DARCY_LAW (0) = Darcy flow ifm.Enum.HP_LAW (1) = Hagen-Poiseuille flow ifm.Enum.MANNING_LAW (2) = Manning-Strickler flow

Physical unit is [m/d].

Parameters:

nFracElement (int) – Fracture element number
value (float) – Value to be set
FracType (IfmFractureType) – Fracture element type
FracMode (IfmFractureMode) – Fracture element selection mode
FracLaw (IfmFractureLaw) – Fracture element flow law

See also

getNumberOfTotalFractureElements, getNumberOf1DFractureElements, getNumberOf2DTriangularFractureElements, getNumberOf2DQuadrilateralFractureElements, getNodalArrayOfFractureElement, getFracArea, getFracFlowConductivity, getFracFlowStorativity, getFracFlowCompressibility, getFracFlowSinkSource, getFracFlowDensityRatio, getFracFlowExpansionCoeff, getFracTransferIn, getFracTransferOut, getFracMassPorosity, getFracMassSorptionCoeff, getFracMassDiffusion, getFracMassLongDispersivity, getFracMassTransDispersivity, getFracMassDecayRate, getFracMassSinkSource, getFracMassTransferIn, getFracMassTransferOut, getFracHeatPorosity, getFracHeatFluidCapacity, getFracHeatSolidCapacity, getFracHeatFluidConductivity, getFracHeatSolidConductivity, getFracHeatLongDispersivity, getFracHeatTransDispersivity, getFracHeatFluidSinkSource, getFracHeatSolidSinkSource, getFracHeatTransferIn, getFracHeatTransferOut, createFracElement, deleteFracElement, deleteFracElements, setFracArea, setFracFlowConductivity, setFracFlowStorativity, setFracFlowCompressibility, setFracFlowSinkSource, setFracFlowDensityRatio, setFracFlowExpansionCoeff, setFracFlowTransferIn, setFracFlowTransferOut, setFracMassPorosity, setFracMassSorptionCoeff, setFracMassDiffusion, setFracMassLongDispersivity, setFracMassTransDispersivity, setFracMassDecayRate, setFracMassSinkSource, setFracMassTransferIn, setFracMassTransferOut, setFracHeatPorosity, setFracHeatFluidCapacity, setFracHeatSolidCapacity, setFracHeatFluidConductivity, setFracHeatSolidConductivity, setFracHeatLongDispersivity, setFracHeatTransDispersivity, setFracHeatFluidSinkSource, setFracHeatSolidSinkSource, setFracHeatTransferIn, setFracHeatTransferOut, getFracElementDiameter, getFracLaw, setFracLaw

setGeoCoordinateSystem(int, string)

Define GEO coordinate system FEFLOW can hold multiple coordinate system definition identified by a unique CS id:

IfmCS_WGEO : WGEO coordinate system definition IfmCS_AUTHSTR: Authority string[i.e.,’epsg:4326’] IfmCS_CRSWKT : CRS WKT string IfmCS_PROJ : PROJ4 string IfmCS_JSON : JSON string with PROJ parameters IfmCS_PRJFILE : Projection file (ESRI compatible)

It’s responsibility of the client code to reset or adapt the other definitions if one definition was changed. All coordinate system definitions are UTF-8 encoded and allow therefore the use of localized characters.

Parameters:

cs (IfmGEOCS) – Type of coordinate system description
pszCS (str) – WGEO specific UTF-8 encoded coordinate system id

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

setInitialSimulationTime(tini)

Set the initial simulation time (tini >= 0.)

Physical unit is [d]

Parameters:: tini (float) – Initial time stage [d]
Returns:: The initial simulation time (tini >= 0.)
Return type:: float

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

setInitialTimeIncrement(init_dt)

Set the initial time step length

Physical unit is [d]

Parameters:: init_dt (float) – Inital time step [d]
Returns:: The initial time step length
Return type:: float

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

setIterativeNonSymEquationSolverType(ITERNONSYMEQSFlag)

Set the type of iterative nonsymmetric equation solver Possible arguments for ITERNONSYMEQSFlag are:

ifm.Enum.ITERNONSYMEQS_ORTHO (0) = ORTHOMIN method ifm.Enum.ITERNONSYMEQS_GMRES (1) = GMRES method ifm.Enum.ITERNONSYMEQS_CGS (2) = CGS method ifm.Enum.ITERNONSYMEQS_BICGSTAB (3) = BICGSTAB method ifm.Enum.ITERNONSYMEQS_BICGSTABP (4) = BICGSTABP method ifm.Enum.ITERNONSYMEQS_AMG (5) = AMG method

Parameters:: ITERNONSYMEQSFlag (int) – ITERNONSYMEQS flag to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setIterativeSymEquationSolverType(ITERSYMEQSFlag)

Set the type of iterative symmetric equation solver Possible arguments for ITERSYMEQSFlag are:

ifm.Enum.ITERSYMEQS_PCG (0) = conjugate gradient method ifm.Enum.ITERSYMEQS_AMG (1) = algebraic multigrid method

Parameters:: ITERSYMEQSFlag (int) – ITERSYMEQSFlag to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setMassMatricesFlag(MMType)

Set the flag of consistent versus lumped mass matrices Possible arguments for MMType are:

ifm.Enum.CONSISTENT_MM (0) = consistent mass matrix ifm.Enum.LUMPED_MM (1) = lumped mass matrix

Parameters:: MMType (int) – Mass matrix flag to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setMatAnisotropyAngle2D(element, value)

Set the anisotropic rotation (Euler) angle for a 2D problem

Physical unit is [deg]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatAnisotropyAnglePhi(element, value)

Set the anisotropic rotation (Euler) phi angle for a 3D problem

Physical unit is [deg]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatAnisotropyAnglePsi(element, value)

Set the anisotropic rotation (Euler) psi angle for a 3D problem

Physical unit is [deg]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatAnisotropyAngleTheta(element, value)

Set the anisotropic rotation (Euler) theta angle for a 3D problem.

Physical unit is [deg].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatAnisotropyFactor2D(element, value)

Set the anisotropy factor for a 2D problem

Physical unit is [1].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatBottom2D(element, value)

Set the elevation of aquifer bottom geometry for a 2D problem

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatConductivityTensor3D(element, tensor)

Set the conductivity anisotropy tensor for a finite element

Parameters:

element (int) – Element number (first element = 0)
tensor (float[3][3]) – 3x3 tensor matrix of conductivity anisotropy

See also

setMatConductivityTensor3DEnabled(enable)

Enable conductivity anisotropy tensors for finite elements

Parameters:: enable (bool) – Enable flag
Returns:: the previous value of this flag
Return type:: bool

Examples

>>> doc.setMatConductivityTensor3DEnabled(True)
>>> doc.setFlowAnisotropy(ifm.Enum.ANISOTROPIC3)

Warning

This function requires to call the function “setFlowAnisotropy” for the tensor to be enabled. See example above.

See also

setMatConductivityValue2D(element, value)

Set the hydraulic conductivity value for a 2D flow problem

Physical unit of the value to be set is [m2/d] for horizontal confined problems (it means the transmissivity) or [m/d] for horizontal unconfined, vertical or axisymmetric problems.

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatElementActive(element, active)

Sets the selected element active or inactive

Parameters:

element (int) – Element number
active (int) – 1 to activate, 0 to deactivate an element

See also

setMatFlowCompressibility(element, value)

Set the compressibility for a transient flow problem

Physical unit is [1/m] for 3D or 2D vertical/axisymmetric and unconfined, or [1] if 2D horizontal and confined.

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatFlowDensityRatio(element, value)

Set the density ratio for density-coupled problems

Physical unit is [1]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatFlowExpansionCoeff(element, value)

Set the volumetric expansion coefficient for thermally density-coupled problems

Physical unit is [1/K].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatFlowRechargeValue(element, value)

Set the recharge (sink/source) value for a flow problem

Physical unit of the value to be set is [m/d].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatFlowSinkSource(element, value)

Set the sink/source parameter for a flow problem

Physical unit is [1/d] for 3D or 2D vertical/axisymmetric, or [m/d] if 2D horizontal.

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatFlowStorativity(element, value)

Set the storativity parameter for a flow problem.

Physical unit is [1]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatFlowTransferIn(element, value)

Set the transfer rate for inflow of a flow problem

Physical unit is [1/d] for 3D or 2D vertical/axisymmetric, or [m/d] if 2D horizontal, except unconfined 2D without integral BC’s where [1/d]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatFlowTransferOut(element, value)

Set the transfer rate for inflow of a flow problem

Physical unit is [1/d] for 3D or 2D vertical/axisymmetric, or [m/d] if 2D horizontal, except unconfined 2D without integral BC’s where [1/d]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatAnglePitch(element, value)

Set the anisotropic rotation pitch angle for a 3D problem

Physical unit is [deg].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatAngleYaw(element, value)

Set the anisotropic rotation yaw angle for a 3D problem.

Physical unit is [deg].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatAquiferThickness(element, value)

Set the aquifer thickness applied to a 2D heat transport problem.

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatFluidCapacity(element, value)

Set the volumetric heat capacity of fluid for a heat transport problem

Physical unit is [J m3/K].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatFluidConductivity(element, value)

Set the heat conductivity of fluid for a heat transport problem.

Physical unit is [J/m/d/K].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatFluidSinkSource(element, value)

Set the heat source/sink of fluid for a heat transport problem

Physical unit is [J/m3/d] for 3D and 2D vertical and axisymmetric or [J/m2/d] for 2D horizontal

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatMaxLongDispersivity(element, value)

Set the maximal longitudinal dispersivity applied to a heat transport problem

Physical unit is [m]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatMaxTransDispersivity(element, value)

Set the maximal transverse dispersivity applied to a heat transport problem

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatMinLongDispersivity(element, value)

Set the minimal longitudinal dispersivity applied to a heat transport problem

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatMinTransDispersivity(element, value)

Set the minimal transverse dispersivity applied to a heat transport problem

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatPorosity(element, value)

Set the kinematic porosity applied to a heat transport problem

Physical unit is [1].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatSolidCapacity(element, value)

Set the volumetric heat capacity of solid for a heat transport problem

Physical unit is [J m3/K].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatSolidConductivity(element, value)

Set the heat conductivity of solid for a heat transport problem

Physical unit is [J/m/d/K].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatSolidSinkSource(element, value)

Set the heat source/sink of solid for a heat transport problem

Physical unit is [J/m3/d] for 3D and 2D vertical and axisymmetric or [J/m2/d] for 2D horizontal

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatTransferIn(element, value)

Set the transfer rate for influx of a heat transport problem

Physical unit is [J/m2/d/K] for 3D or 2D vertical/ axisymmetric, or [J/m2/d/K] if 2D horizontal, except unconfined 2D for integral BC’s where [J/m/d/K].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatHeatTransferOut(element, value)

Set the transfer rate for outflux of a heat transport problem

Physical unit is [J/m2/d/K] for 3D or 2D vertical/ axisymmetric, or [J/m2/d/K] if 2D horizontal, except unconfined 2D for integral BC’s where [J/m/d/K].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassAnglePitch(element, value)

Set the anisotropic rotation pitch angle for a 3D problem

Physical unit is [deg]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassAngleYaw(element, value)

Set the anisotropic rotation yaw angle for a 3D problem.

Physical unit is [deg].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassAquiferThickness(element, value)

Set the aquifer thickness applied to a 2D mass transport problem

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassDecayRate(element, value)

Set the decay rate for a mass transport problem

Physical unit is [1/d].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassDecayRate2(element, value)

Set the decay rate 2 for a mass transport problem.

Physical units are [1] MICHAELIS_MENTEN.

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassDiffusion(element, value)

Set the molecular diffusion of a mass transport problem

Physical unit is [m2/d].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassLongDispersivity(element, value)

Set the Longitudinal Dispersivity of an element

Parameters:

element (int) – element index
value (float) – longitudinal dispersivity [m]

setMatMassMaxLongDispersivity(element, value)

Set the maximal longitudinal dispersivity applied to a mass transport problem

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassMaxTransDispersivity(element, value)

Set the maximal transverse dispersivity applied to a mass transport problem

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassMinLongDispersivity(element, value)

Set the minimal longitudinal dispersivity applied to a mass transport problem

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassMinTransDispersivity(element, value)

Set the minimal transverse dispersivity applied to a mass transport problem

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassPorosity(element, value)

Set the kinematic porosity applied to a mass transport problem

Physical unit is [1].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassSinkSource(element, value)

Set the sink/source for a mass transport problem

Physical unit is [g/m3/d] for 3D or 2D vertical/ axisymmetric, or [g/m2/d] if 2D horizontal.

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassSorptionCoeff1(element, value)

Set the sorption coefficient applied to a mass transport problem Henry sorption - the Henry coefficient, Freundlich or Langmuir sorption - the numerator (b1, k1) sorption coefficient.

Physical unit is [1].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassSorptionCoeff2(element, value)

Set the sorption coefficient applied to a mass transport problem Freundlich or Langmuir sorption - the denominator (b2, k2) sorption coefficient,

Physical unit is [1] for Freundlich and [l/mg] for Langmuir sorption.

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassTransDispersivity(element, value)

Set the transveral Dispersivity of an element.

Physical unit is [m]

Parameters:

element (int) – element index
value (float) – transversal dispersivity

setMatMassTransferIn(element, value)

Set the transfer rate for influx of a mass transport problem.

Physical unit is [m/d] for 3D or 2D vertical/ axisymmetric, or [m/d] if 2D horizontal, except unconfined 2D for integral BC’s where [m2/d].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatMassTransferOut(element, value)

Set the transfer rate for outflux of a mass transport problem

Physical unit is [m/d] for 3D or 2D vertical/ axisymmetric, or [m/d] if 2D horizontal, except unconfined 2D for integral BC’s where [m2/d].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatTops2D(element, value)

Set the elevation of aquifer top geometry for a 2D problem

Physical unit is [m].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatAirEntryPressureHead(element, value)

Set the air pressure head value for unsaturated problems

Physical unit are [m] - IfmPM_VAN_GENUCHTEN not available - IfmPM_BROOKS_COREY [m] - IfmPM_HAVERKAMP [m] - IfmPM_EXPONENTIAL [m] - IfmPM_LINEAR [m] - IfmPM_VG_MODIFIED

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatFittingCoefficient(element, value)

Set the fitting coefficient value for unsaturated problems

Physical unit are [1/m] - IfmPM_VAN_GENUCHTEN [1/m] - IfmPM_BROOKS_COREY [m] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL [m] - IfmPM_LINEAR [1/m] - IfmPM_VG_MODIFIED

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatFittingCoefficientDryingCurve(element, value)

Set the fitting coefficient value for the hysteretic drying curve for unsaturated problems

Physical unit are [1/m] - IfmPM_VAN_GENUCHTEN [1/m] - IfmPM_BROOKS_COREY [m] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL [m] - IfmPM_LINEAR [1/m] - IfmPM_VG_MODIFIED

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatFittingExponent(element, value)

Set the fitting exponent value for unsaturated problems

Physical unit are [1] - IfmPM_VAN_GENUCHTEN [1] - IfmPM_BROOKS_COREY [1] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatFittingExponent2(element, value)

Set the fitting exponent 2 value for unsaturated problems.

Physical unit are not available - IfmPM_VAN_GENUCHTEN [1] - IfmPM_BROOKS_COREY [m] - IfmPM_HAVERKAMP [1/m] - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatFittingExponent2DryingCurve(element, value)

Set the fitting exponent 2 value for the hysteretic drying curve for unsaturated problems

Physical unit are [1] - IfmPM_VAN_GENUCHTEN [1] - IfmPM_BROOKS_COREY [1] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatFittingExponent3(element, value)

Set the fitting exponent 3 value for unsaturated problems

Physical unit are not available - IfmPM_VAN_GENUCHTEN not available - IfmPM_BROOKS_COREY [1] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatFittingExponent3DryingCurve(element, value)

Set the fitting exponent 3 value for the hysteretic drying curve for unsaturated problems

Physical unit are [1] - IfmPM_VAN_GENUCHTEN [1] - IfmPM_BROOKS_COREY [1] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatFittingExponentDryingCurve(element, value)

Set the fitting exponent value for the hysteretic drying curve for unsaturated problems

Physical unit are [1] - IfmPM_VAN_GENUCHTEN [1] - IfmPM_BROOKS_COREY [1] - IfmPM_HAVERKAMP not available - IfmPM_EXPONENTIAL not available - IfmPM_LINEAR [1] - IfmPM_VG_MODIFIED

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatMaximumSaturation(element, value)

Set the maximum saturation value for unsaturated problems

Physical unit is [1].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatModelType(element, value)

Set the type of parametric model for unsaturated problems

Value indicates IfmPM_VAN_GENUCHTEN (0) = Van Genuchten-Mualem model IfmPM_BROOKS_COREY (1) = Brooks-Corey model IfmPM_HAVERKAMP (2) = Haverkamp et al. model IfmPM_EXPONENTIAL (3) = Exponential model IfmPM_LINEAR (4) = Linear model IfmPM_VG_MODIFIED (5) = Van Genuchten modified parameter model IfmPM_SPLINES (6) = Splines parameter model

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatPorosity(element, value)

Set the porosity value for unsaturated problems

Physical unit is [1].

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatUnsatResidualSaturation(element, value)

Set the residual saturation value for unsaturated problem

Physical unit is [1]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatXConductivityValue3D(element, value)

Set the hydraulic conductivity value in the x-direction for a 3D flow problem.

Physical unit of the value to be set is [m/d]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatYConductivityValue3D(element, value)

Set the hydraulic conductivity value in the y-direction for a 3D flow problem

Physical unit of the value to be set is [m/d]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMatZConductivityValue3D(element, value)

Set the hydraulic conductivity value in the z-direction for a 3D flow problem

Physical unit of the value to be set is [m/d]

Parameters:

element (int) – Element number
value (float) – Value to be set

See also

setMeshType(int)

Set the type of meshing Possible arguments for MSHFlag are:

ifm.Enum.MSH_TRIA (0) = triangular element mesh ifm.Enum.MSH_QUAD (1) = quadrilateral element mesh

Parameters:: MSHFlag (int) – MSHFlag to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setModified(int): Set/Reset the FEM problem’s modified state

setMultiLayerWellAttrTSID(mlw_id, mlw_attribute, ts_id)

Set time-series id for the flow rate of a multilayer well addressed by index nId.

Parameters:

mlw_id (int) – Node independent ID (index) of the multilayer well
mlw_attribute (IfmMLW_ATTR) – Multi-layer well attribute
ts_id (int) – Time-series id (power function id) for the flow rate

See also

setMultiLayerWellAttrValue(nId, nAttr, dValue)

Set constant attribute value of a multilayer well

Parameters:

nId (int) – Node independent ID (index) of the multilayer well
nAttr (IfmMLW_ATTR) – Multi-layer well attribute
dValue (float) – Flow rate to be set [m^3/d]

See also

setMultiSpeciesId(species_id)

Set the Id of current chemical species equations The Id must be >= 0 and < IfmGetNumberOfSpecies()

Parameters:: species_id (int) – Species 0 <= Id < IfmGetNumberOfSpecies() to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setNodalRefDistrValue(distr_id, node, value)

Set the value of node node in nodal reference distribution with id rID

Parameters:

distr_id (long) – Nodal reference distribution ID [0, … ]
node (long) – Node index [0 … np_3d]
value (float) – Value to be set as property at the node

See also

getNumberOfNodalRefDistr, getNumberOfElementalRefDistr, getNodalRefDistrName, getElementalRefDistrName, getNodalRefDistrIdByName, getElementalRefDistrIdByName, getNodalRefDistrValue, getElementalRefDistrValue, setNodalRefDistrValue, setElementalRefDistrValue, createNodalRefDistr, createElementalRefDistr, deleteNodalRefDistr, deleteElementalRefDistr, enableNodalRefDistrRecording, enableElementalRefDistrRecording, getNumberOfNodalExprDistr, getNumberOfElementalExprDistr, getNodalExprDistrName, getElementalExprDistrName, getNodalExprDistrIdByName, getElementalExprDistrIdByName, getNodalExprDistrValue, getElementalExprDistrValue, getNodalRefDistrValueAtXYSlice, getNodalRefDistrValueAtXYZ, getExpression, setExpression

setNodalRefDistrValues(distr_id, values, start=0, count=len(values))

Sets multiple values of a reference distribution addressed by id and range.

Parameters:

distr_id (int) – User distribution ID
values ([float] or float) – values to be set. If a single float values is given, it will be assigned to all nodes in the given range
start (int, optional) – first node to assign new values
count (int, optional) – number of values to assign

Examples

>>> doc.setNodalRefDistrValues(3, 0.001)
>>> doc.setNodalRefDistrValues(3, [0.1, 0.2, 0.3], 100)

setObsLabel(oID, obs_label)

IfmSetObsLabel - Change the name of a given observation point Indexing starts at 0

Parameters:

oID (int) – Observation point ID (0, … )
obs_label (str) – Observation point label

See also

getNumberOfValidObsPoints, getTypeOfObsId, getXOfObsId, getYOfObsId, getZOfObsId, getFlowValueOfObsIdAtCurrentTime, getMassValueOfObsIdAtCurrentTime, getHeatValueOfObsIdAtCurrentTime, getPressureValueOfObsIdAtCurrentTime, getSaturationValueOfObsIdAtCurrentTime, getMoistureContentValueOfObsIdAtCurrentTime, getObsLabel, setObsLabel, findObsByLabel

setOutput(filename[, fmode[, listoftimesteps]])

Pre-Define output options before running a model.

Parameters:

filename (str) – filename (dac or dar) of the output file
filemode (int, optional) – file mode (e.g. ifm.Enum.F_ASCII)
listoftimesteps ([float], optional) – list of time steps to be saved.

Examples

>>> # Generates an ASCII DAC file named 'output.dac' with output at 0, 10, and 20 days
>>> doc.setOutput('output.dac', ifm.Enum.F_ASCII, [0, 10, 20])
>>> doc.startSimulator()

setParamExpression(parameter, xml)

Set the expression of a parameter.

Parameters:

parameter (ifm.Parameter) – The Parameter to be assigned
xml (str) – The expression content as XML string

setParamPowId(param_id, item, pow_id)

Set power function id as a parameter value The function set a power function id as parameter value, passing 0 resets the parameter value (clears b.c.)

Parameters:

param_id (IfmParamID) – Parameter identification code IfmP_*
item (int) – Item index, e.g., node or element number
pow_id (int) – Power function id

See also

setParamPowIds(param_id, values, first_item, item_count)

Assign time series to multiple nodes, either as a vector of time series ids or as a single id that is assigned to all nodes. The function sets the time series id as parameter value, passing 0 resets the parameter value (clears b.c.)

Parameters:

param_id (IfmParamID) – Parameter identification code IfmP_*
pow_id (int or [int]) – power ids to be assigned. If provided as a single integer, same id will be assigned to all nodes.
first_item (int, optional) – first item index to be assigned
item_count (int, optional) – number of items to be assigned

setParamValue(parameter, item, value)

Set value of a parameter addressed by id and index This functions changes the value of a elements, a node, or fracture element.

Parameters:

parameter (int or (int, str)) – Parameter identification as code IfmP_* or with sub-id (IfmP_*, sub-parameter)
item (int) – Item index, e.g., node or element number
value (float) – Item value

Examples

>>> doc.setParamValue(ifm.Enum.P_SOUF, 0, 0.001)

See also

setParamValues(parameter, values, first_item=0, item_count=len(values))

Sets multiple values of a parameter addressed by a list of IDs or a start-ID and range This functions changes a range of elements, nodes, and fracture element values. {int|(int,string)} param, int indices[], double values[])

Parameters:

parameter (int or (int, str)) – Parameter identification as code IfmP_* or with sub-id (IfmP_*, sub-parameter)
values (float or [float]) – Values to be set. can be provided as a list (applied to individual items) or a single float value (applied to all items)
first_item (int, optional) – Index of first item to transfer
item_count (int, optional) – Number of items to transfer
indices ([int], optional) – list of indices

Examples

>>> # to set parameter values globally
>>> doc.setParamValues(ifm.Enum.P_SOUF, 0.001)
>>> # to set parameter values from a range: Source/Sink values in list are set to element IDs from 100 on
>>> doc.setParamValues(ifm.Enum.P_SOUF, [0.1, 0.2, 0.3], 100)
>>> # to set parameter value to a selection of elements
>>> top_elems = doc.getSelectionItems(ifm.Enum.SEL_ELEMS, "toplayer")
>>> doc.setParamValues(ifm.Enum.P_SOUF,top_elems, 100) # instead of a constant value, also a list of the same length as the IDs can be passed

See also

setPredictorCorrectorMethod(PCSFlag)

Set the method of predictor-corrector time stepping.

Parameters:: PCSFlag (int) – PCS flag to be set ifm.Enum.PCS_FEBE (0) = Forward Euler/Backward Euler (FE/BE) or ifm.Enum.PCS_ABTR (1) = Adams-Bashforth/Trapezoid Rule (AB/TR)

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

setPredictorCorrectorTimeStepIncreasingRate(IncRate)

Sets the time step increasing rate used for predictor-corrector time stepping schemes

Use a negative IncRate to switch off bounding of time step increasing

IncRate is dimensionless

Parameters:: IncRate (float) – Time step increasing rate > 1.0

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

setPredictorCorrectorTimeStepMaximumSize(Mtsize)

Sets the maximum time step size applied to predictor-corrector time stepping schemes.

Use a negative Mtsize to switch off bounding of time step size.

Physical unit is [d].

Parameters:: Mtsize (float) – Maximum time step size [d] > 0.0

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

setPredictorHeadTimeValue(node, value)

Set the predictor value for the hydraulic head at the current time step for a transient flow problem in using a predictor-corrector time stepping scheme

Physical unit is [m]

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setPredictorHeatTimeValue(node, value)

Set the predictor value for temperature (heat) at the current time step for a transient heat transport problem in using a predictor-corrector time stepping scheme

Physical unit is [deg C].

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setPredictorMassTimeValue(node, value)

Set the predictor value for mass (concentration) at the current time step for a transient mass transport problem in using a predictor-corrector time stepping scheme.

Physical unit is [mg/l].

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setReferenceTime(tref)

Set the reference time.

Parameters:: tref (datetime.datetime) – Reference time as date-time structure

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

setResultsFlowHeadPreviousTimeValue(node, value)

Retrieve the hydraulic head at previous time step for a transient flow problem.

Physical unit is [m],

Parameters:

node (int) – Node number
value (float) – Value to be set

Return type:

The hydraulic head value at previous time step

See also

setResultsFlowHeadValue(node, value)

Set the resulting hydraulic head value for a flow problem.

Physical unit is [m].

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setResultsFlowMoistureContentValue(node, value)

Set the resulting moisture content value for an unsaturated flow problem.

Physical unit is [1]

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setResultsFlowPressureValue(node, value)

Set the resulting pressure value for a flow problem.

Physical unit is [kPa].

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setResultsFlowSaturationValue(node, value)

Set the resulting saturation value for an unsaturated flow problem

Physical unit is [1].

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setResultsTransportHeatPreviousTimeValue(node, value)

Retrieve the temperature (heat) at previous time step for a transient heat transport problem

Physical unit is [deg C].

Parameters:

node (int) – Node number
value (float) – Value to be set

Returns:

The temperature (heat) value at previous time step

Return type:

float

See also

setResultsTransportHeatValue(node, value)

Set the Temperature of a node.

Parameters:

node (int) – node index
value (float) – temperature

setResultsTransportMassIntermediateValue(node, value)

Set the intermediate mass (concentration) value for a mass transport problem.

Physical unit is [mg/l].

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setResultsTransportMassPreviousTimeValue(node, value)

Retrieve the mass (concentration) at previous time step for a transient mass transport problem

Physical unit is [mg/l]

Parameters:

node (int) – Node number
value (float) – Value to be set

Returns:

The mass (concentration) value at previous time step

Return type:

float

See also

setResultsTransportMassValue(node, value)

Set the resulting mass (concentration) value for a transport problem

Physical unit is [mg/l].

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setRichardsEquationFormType(UFORMFlag)

Set the form of the Richards equation Possible arguments for UFORMFlag are:

ifm.Enum.UFORM_H (0) = Standard h-based form
ifm.Enum.UFORM_MIXED (1) = Mixed s-h form
ifm.Enum.UFORM_VARSUB (2) = Variable substitution form

Parameters:: UFORMFlag (int) – UFORM flag to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setSaveVersion(saveVersion)

Sets the module version to be written into the FEM file IfmSetSaveVersion() sets the version that will be used when Serialize writes the modules related document data into FEFLOW’s FEM file. Depending on the version (hexadecimal) the Serialize method should restrict it’s I/O to those parts only supported by this version.

Parameters:: saveVersion (int) – Version used for saving
Returns:: Version to be written into FEM file.
Return type:: int

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setSelectionItem(sel_type, sel_index, item)

Sets an item within selection

Parameters:

sel_type (IfmSEL_TYPE) – Selection type
sel_index (int) – Selection index
item (int) – Item to set

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

setSelectionItems(sel_type, selection, items, operation=set)

Fetch all items of a selection at once

IfmSetSelectionItems() sets or modifies the selection specified by selection type and index.

Supported operations are:

IfmSOP_SET: Set items as new selection, all previously helt items are cleared.
IfmSOP_INTERSECT: Intersect current selection with passed items: only items in both current and new selection remain.
IfmSOP_UNION: Union current selection with passed items: selection contains all items of both current and new selection.
IfmSOP_SUBTRACT: Subtract passed items from current selection: selection contains all items of the current selection that are not in the new selection.

Parameters:

sel_type (IfmSEL_TYPE) – Selection type
selection (int or str) – Selection index or name
items ([int]) – list of selection items
operation (IfmSEL_OP, optional) – Selection operation: set|clear|intersect|union|subtract

See also

getNumberOfSelections, getSelectionCapacity, findSelection, createSelection, deleteSelection, getSelectionName, getSelectedItemCount, enumSelectionItems, selectionItemIsSet, setSelectionItem, getSelectionItems, setSelectionItems, setDiagramBudgetMode, getDiagramBudgetMode, setDiagramContentType, getDiagramContentType

setSolver(solver_name)

Changes the equation solver type.

Parameters:: solver_name ({"pardiso", "pcg", "samg", "petsc_ksp", "petsc_amg"}) – The name of the solver to be chosen.

Examples

>>> doc.setSolver("pardiso")

setSpeciesKineticsArrhenius(species_id, pK, pN=None)

Activate Arrhenius reactions kinetics and set optionally Arrhenius parameter.

Parameters:

species_id (int) – Species index
pK ([float]) – Array of coefficients K[iSpecies]
pN ([float], optional) – Array of exponents N[iSpecies] (may be null or omitted for all ones)

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setSpeciesKineticsDegradation(species_id, pK, pN=None)

Activate degradation reactions kinetics and set optionally degradation parameter.

Parameters:

species_id (int) – Species index
pK ([float]) – Array of coefficients K[iSpecies]
pN ([float], optional) – Array of exponents N[iSpecies] (may be null or omitted for all ones)

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setSpeciesKineticsMonod(int, pK, pN, pB, pD, pE)

Activate Monod reactions kinetics and set optionally Monod parameter.

Parameters:

species_id (int) – Species index
pK ([float]) – Coefficient array K[iSpecies+1]
pN ([float]) – Exponent array n[iSpecies+2] (may be null or omitted for all ones)
pB ([float]) – Coefficient array B[(iSpecies+1)*(iSpecies+2)/2]
pD ([float]) – Coefficient array D[(iSpecies+1)*(iSpecies+2)/2]
pE ([float]) – Coefficient array E[(iSpecies+1)*(iSpecies+2)/2]

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setSpeciesKineticsUserDefined(species_id, KineticsXML)

Activate user-defined reactions kinetics with MATHED.

Parameters:

species_id (int) – Species index
KineticsXML (str) – MATHED formula as encoded XML string

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setSpeciesName(species_id, species_name)

Rename species name (e.g., necessary to rename first species)

Parameters:

species_id (int) – Species 0 <= nId < IfmGetNumberOfSpecies()
species_name (str) – New species name

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setSpeciesPhaseType(species_id, species_phase)

Set species phase to fluid or solid

Parameters:

species_id (int) – Species 0 <= iSpecies < IfmGetNumberOfSpecies()
species_phase ({ifm.Enum.FLUID_PHASE, ifm.Enum.SOLID_PHASE}) – Species phase type

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setSpeciesType(species_id, species_type)

Set the type of a species.

Parameters:

species_id (int) – Index of species
species_type (IfmSpeciesType) – Species type

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setSplineConductivityFunction(int, [string, int, int, list of [double, double] ])

Sets the spline function dataset for relative conductivity function for a given Id >= 1.

Parameters:

spline_id (int) – Spline ID number (1, 2, …) requested
pSpline (str) – Spline function data structure (storing the spline function data to be set)

Returns:

spline curve

Return type:

IfmSpline

See also

setSplineConductivityFunction2(int, name , int, int, list of [double, double, double] ])

Sets the spline function dataset for relative conductivity function for a given Id >= 1.

Parameters:

spline_id (int) – Spline ID number (1, 2, …) requested
pSpline (str) – Spline function data structure (storing the spline function data to be set)

Returns:

spline curve

Return type:

IfmSpline2

See also

setSplineConductivityId(element, spline_id, curve_type)

Set spline Id number for relative conductivity function at given element number.

Spline Id must be positive > 0, Spline data have to be available (allocated) for the Id to be set, Function is only applicable for unsaturated problems, A DRYING_CURVE type can only be set for hysteretic parameters.

Parameters:

element (int) – Element number
spline_id (int) – Spline Id (1, 2, …) to be set
curve_type (int) – ifm.Enum.WETTING_CURVE(0) | ifm.Enum.DRYING_CURVE(1) ifm.Enum.DRYING_CURVE is only appropriate for hysteretic problems

See also

setSplineSaturationFunction(spline_id, [string, int, int, list of [double, double] ])

Sets the spline function dataset for capillary saturation function for a given Id >= 1.

Parameters:

spline_id (int) – Spline ID number (1, 2, …) requested
pSpline (str) – Spline function data structure (storing the spline function data to be set)

Returns:

True if successful, otherwise False.

Return type:

bool

See also

setSplineSaturationFunction2(spline_id, name , int, int, list of [double, double, double] ])

Sets the spline function dataset for capillary saturation function for a given Id >= 1.

Parameters:

spline_id (int) – Spline ID number (1, 2, …) requested
pSpline (str) – Spline function data structure (storing the spline function data to be set)

See also

setSplineSaturationId(element, spline_id, curveType)

Set spline Id number for saturation function at given element number

Parameters:

element (int) – Element number
spline_id (int) – Spline Id (1, 2, …) to be set
curveType (int) – ifm.Enum.WETTING_CURVE(0) | ifm.Enum.DRYING_CURVE(1) NOTE: ifm.Enum.DRYING_CURVE is only appropriate for hysteretic problems

See also

setTimeSteppingErrorTolerance(ErrorTolerance)

Sets the error tolerance for the adaptive time stepping scheme.

Tolerance is dimensionless.

Parameters:: ErrorTolerance (float) – Error tolerance to be used for controlling adaptive time stepping

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

setTimeSteppingKind(KTSFlag)

Set the kind of time stepping Possible arguments for KTSFlag are:

ifm.Enum.KTS_PCS (0) = Predictor-corrector scheme
ifm.Enum.KTS_CTS (1) = Constant time stepping scheme

Parameters:: KTSFlag (int) – KTS flag to be set

See also

getReferenceTime, setReferenceTime, getAbsoluteSimulationTime, getInitialSimulationTime, setInitialSimulationTime, getFinalSimulationTime, setFinalSimulationTime, getInitialTimeIncrement, setInitialTimeIncrement, getCurrentTimeIncrement, isTimeStepRejected, getTimeSteppingErrorTolerance, setTimeSteppingErrorTolerance, getTimeSteppingKind, setTimeSteppingKind, getPredictorCorrectorMethod, setPredictorCorrectorMethod, getPredictorCorrectorTimeStepIncreasingRate, setPredictorCorrectorTimeStepIncreasingRate, getPredictorCorrectorTimeStepMaximumSize, setPredictorCorrectorTimeStepMaximumSize, queryCustomTimes, setCustomTimes

setUnsatDerivativeCapaType(CAPAFlag)

Set the type of derivation of the capacity term Possible arguments for CAPAFlag are:

ifm.Enum.CAPA_CSS (0) = Chord-slope scheme
ifm.Enum.CAPA_ANA (1) = Analytical scheme
ifm.Enum.CAPA_ANA_TCE (2) = Time-centred analytic scheme

Parameters:: CAPAFlag (int) – CAPA flag to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setUnsatErrorCheckOption(CPSFlag)

Set the error check option for unsaturated problems Possible arguments for CPSFlag are:

ifm.Enum.CPS_DONT (0) = Don’t check capillary head and saturation error; if applicable, check residual
ifm.Enum.CPS_DO (1) = Check capillary head and saturation error; if applicable, check residual
ifm.Enum.CPS_OMITRES (2) = Don’t check capillary head and saturation error; don’t check residual
ifm.Enum.CPS_OMITRES_DO (3) = Check capillary head and saturation error; don’t check residual

Parameters:: CPSFlag (int) – CPS flag to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setUnsatHysteresisCondition(): SetUnsatHysteresisCondition: Only appropriate for unsaturated problems Switch on hysteresis for unsaturated problems

See also

getMatConductivityValue2D, getMatXConductivityValue3D, getMatYConductivityValue3D, getMatZConductivityValue3D, getMatFlowRechargeValue, getMatAnisotropyFactor2D, getMatAnisotropyAngle2D, getMatBottom2D, getMatTops2D, getMatFlowStorativity, getMatFlowDensityRatio, getMatFlowExpansionCoeff, getMatFlowCompressibility, getMatFlowSinkSource, getMatFlowTransferIn, getMatFlowTransferOut, matUnsatModelType, getUnsatHysteresisCondition, getMatUnsatPorosity, getMatUnsatMaximumSaturation, getMatUnsatResidualSaturation, getMatUnsatFittingCoefficient, getMatUnsatFittingCoefficientDryingCurve, getMatUnsatFittingExponent, getMatUnsatFittingExponentDryingCurve, getMatUnsatFittingExponent2, getMatUnsatFittingExponent2DryingCurve, getMatUnsatFittingExponent3, getMatUnsatFittingExponent3DryingCurve, getMatUnsatAirEntryPressureHead, getMatMassAquiferThickness, getMatMassPorosity, getMatMassSorptionCoeff1, getMatMassSorptionCoeff2, getMatMassDiffusion, getMatMassMaxLongDispersivity, getMatMassMaxTransDispersivity, getMatMassMinLongDispersivity, getMatMassMinTransDispersivity, getMatMassAnglePitch, getMatMassAngleYaw, getMatMassDecayRate, getMatMassDecayRate2, getMatMassSinkSource, getMatMassTransferIn, getMatMassTransferOut, getMatHeatAquiferThickness, getMatHeatPorosity, getMatHeatSolidCapacity, getMatHeatFluidCapacity, getMatHeatSolidConductivity, getMatHeatFluidConductivity, getMatHeatMaxLongDispersivity, getMatHeatMaxTransDispersivity, getMatHeatMinLongDispersivity, getMatHeatMinTransDispersivity, getMatHeatAnglePitch, getMatHeatAngleYaw, getMatHeatFluidSinkSource, getMatHeatSolidSinkSource, getMatHeatTransferIn, getMatHeatTransferOut, getUnsatHysteresisIndicatorValue, getUnsatHysteresisIndicatorValueAtNode, setUnsatHysteresisIndicatorGeneral, getUnsatHysteresisStarValue, getUnsatHysteresisStarValueAtNode, getMatAnisotropyAnglePhi, getMatAnisotropyAnglePsi, getMatAnisotropyAngleTheta, setMatConductivityValue2D, setMatXConductivityValue3D, setMatYConductivityValue3D, setMatZConductivityValue3D, isMatConductivityTensor3DEnabled, setMatConductivityTensor3DEnabled, getMatConductivityTensor3D, setMatConductivityTensor3D, setMatFlowRechargeValue, setMatAnisotropyFactor2D, setMatAnisotropyAngle2D, setMatBottom2D, setMatTops2D, setMatFlowStorativity, setMatFlowDensityRatio, setMatFlowExpansionCoeff, setMatFlowCompressibility, setMatFlowSinkSource, setMatFlowTransferIn, setMatFlowTransferOut, setMatUnsatModelType, setUnsatHysteresisCondition, setMatUnsatPorosity, setMatUnsatMaximumSaturation, setMatUnsatResidualSaturation, setMatUnsatFittingCoefficient, setMatUnsatFittingCoefficientDryingCurve, setMatUnsatFittingExponent, setMatUnsatFittingExponentDryingCurve, setMatUnsatFittingExponent2, setMatUnsatFittingExponent2DryingCurve, setMatUnsatFittingExponent3, setMatUnsatFittingExponent3DryingCurve, setMatUnsatAirEntryPressureHead, setMatMassAquiferThickness, setMatMassPorosity, setMatMassSorptionCoeff1, setMatMassSorptionCoeff2, setMatMassDiffusion, setMatMassMaxLongDispersivity, setMatMassMaxTransDispersivity, setMatMassMinLongDispersivity, setMatMassMinTransDispersivity, setMatMassAnglePitch, setMatMassAngleYaw, setMatMassDecayRate, setMatMassDecayRate2, setMatMassSinkSource, setMatMassTransferIn, setMatMassTransferOut, setMatHeatAquiferThickness, setMatHeatPorosity, setMatHeatSolidCapacity, setMatHeatFluidCapacity, setMatHeatSolidConductivity, setMatHeatFluidConductivity, setMatHeatMaxLongDispersivity, setMatHeatMaxTransDispersivity, setMatHeatMinLongDispersivity, setMatHeatMinTransDispersivity, setMatHeatAnglePitch, setMatHeatAngleYaw, setMatHeatFluidSinkSource, setMatHeatSolidSinkSource, setMatHeatTransferIn, setMatHeatTransferOut, setMatAnisotropyAnglePhi, setMatAnisotropyAnglePsi, setMatAnisotropyAngleTheta, getSplineSaturationFunction, getSplineConductivityFunction, setSplineSaturationFunction, setSplineConductivityFunction, getSplineSaturationFunction2, getSplineConductivityFunction2, setSplineSaturationFunction2, setSplineConductivityFunction2, getSplineSaturationId, getSplineConductivityId, setSplineSaturationId, setSplineConductivityId, getMatElementActive, setMatElementActive, getViscosityDependency, setViscosityDependency, getParamSize, getParamValue, getParamValues, getParamPowId, getParamPowIds, setParamValue, setParamValues, setParamPowId, setParamIds, resetParamValues, enableParamRecording, getParameter, releaseParameter, getParamSize2, getParamValue2, getParamValues2, setParamValue2, setParamValues2, setParamPowIds2, getParamPowIds2, resetParamValues2, enableParamRecording2

setUnsatHysteresisIndicatorGeneral(indicator)

Sets the indicator vector of all elements (general) for hysteretic unsaturated problems

ifm.Enum.NEUTRAL_DIRECTION (0) = neutral state (average of wetting and drying)
ifm.Enum.WETTING_DIRECTION (1) = wetting direction
ifm.Enum.DRYING_DIRECTION (-1) = drying direction

Parameters:: indicator (int) – indicator vector

See also

setUnsatIterationMethod(iter_method)

Set the iteration method used for unsaturated problems

Parameters:: iter_method (int) – iteration method

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setUnsatWeightingType(ICMFlag)

Set the type of weighting for unsaturated problems Possible arguments for ICMFlag are:

ifm.Enum.ICM_CW (0) = Central weighting
ifm.Enum.ICM_UPW (1) = Upstream weighting

Parameters:: ICMFlag (int) – ICM flag to be set

See also

isDocument, documentVersion, getLoadVersion, getSaveVersion, setSaveVersion, documentSetUserData, documentGetUserData, documentSetEnabled, documentIsEnabled, documentSetModified, documentIsModified, getProblemPath, getProblemTitle, getProblemDescription, getProblemType, getProblemClass, getTimeClass, getProblemProjection, isDivergenceFormTransport, getAMRType, setAMRType, getAMREstimatorType, setAMREstimatorType, getMassMatricesFlag, setMassMatricesFlag, getNumberOfDimensions, getNumberOfNodes, getNumberOfNodesPerSlice, getNumberOfElements, getNumberOfElementsPerLayer, getNumberOfNodesPerElement, getNumberOfNodesPerElement2D, getNumberOfElementNodes, numberOfElementNodes2D, getNumberOfNodeElements, getNumberOfSlices, getCurrentSliceNumber, getNumberOfLayers, getCurrentLayerNumber, setSimulationControlFlag, getSimulationControlFlag, addSpecies, addAgeSpecies, findSpecies, getSpeciesType, setSpeciesType, getNumberOfSpecies, getSpeciesPhaseType, setSpeciesPhaseType, getSpeciesName, setSpeciesName, getSpeciesKineticsType, setSpeciesKineticsDegradation, setSpeciesKineticsArrhenius, setSpeciesKineticsMonod, setSpeciesKineticsUserDefined, getSpeciesKineticsDegradation, getSpeciesKineticsArrhenius, getSpeciesKineticsMonod, getSpeciesKineticsUserDefined, getMultiSpeciesId, setMultiSpeciesId, getMeshType, setMeshType, getEquationSolvingType, setEquationSolvingType, getIterativeSymEquationSolverType, setIterativeSymEquationSolverType, getIterativeNonSymEquationSolverType, setIterativeNonSymEquationSolverType, getRichardsEquationFormType, setRichardsEquationFormType, getUnsatDerivativeCapaType, setUnsatDerivativeCapaType, getUnsatWeightingType, setUnsatWeightingType, getUnsatErrorCheckOption, setUnsatErrorCheckOption, getUnsatIterationMethod, setUnsatIterationMethod, getSolutionResidualNorm2, getSolutionResidualNormMax

setUserMetaData()

Set the User Meta Information in FEFLOW model (Problem Settings).

Parameters:: xml_string – User Meta Information as XML string.

See also

getMetaData, getUserMetaData, parseUserMetaData

Examples

>>> xml_template = '''
>>> <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
>>> <UserMetaData>
>>>   <Team>
>>>     <user>user1</user>
>>>     <user>user2</user>
>>>   </Team>
>>>   <Tasks>
>>>     <task>
>>>       2020-10-01 - Build supermesh
>>>     </task>
>>>   </Tasks>
>>> </UserMetaData>
>>> '''
>>> doc.setUserMetaData(xml_template)

setViscosityDependency(expr_xml)

Sets the viscosity expression for the selected element

Parameters:: expr_xml (str) – Mathed expression for viscosity (utf-8 encoded xml)

See also

setX(node, value)

IfmSetX - Set the X coordinate of a node relative to the origin

Physical unit is [m].

Parameters:

node (int) – Node number
value (float) – x-coordinate value to be set

Returns:

The node’s X coordinate

Return type:

float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

setXVelocityValue(node, value)

Set the x-component of the Darcy velocity vector.

Physical unit is [m/d].

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setY(node, value)

Set the Y coordinate of a node relative to the origin

Physical unit is [m]

Parameters:

node (int) – Node number
value (float) – y-coordinate value to be set

Returns:

The node’s Y coordinate

Return type:

float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

setYVelocityValue(node, value)

Set the y-component of the Darcy velocity vector.

Physical unit is [m/d].

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

setZ(node, value)

Set the Z coordinate of a node relative to the origin

Physical unit is [m]

Parameters:

node (int) – Node number
value (float) – z-coordinate value to be set

Returns:

The node’s Z coordinate

Return type:

float

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem

setZVelocityValue(node, value)

Set the z-component of the Darcy velocity vector

Physical unit is [m/d]

Parameters:

node (int) – Node number
value (float) – Value to be set

See also

simulationControl(ctrl_flag)

Set the simulation control flag. Use this function to control the simulation sequence from within a callback.

Parameters:: ctrl_flag ({ifm.Enum.CTL_CONTINUE, ifm.Enum.CTL_ABORT, ifm.Enum.CTL_BREAK, ifm.Enum.CTL_REPEAT, ifm.Enum.CTL_SKIP}) – sSimulation control flag

singleStep(): Perform a single simulation time step.

startSimulator([dac_or_dar [fmode[, listoftimesteps[, runSimulation = True]]])

Perform a full simulation run.

Examples

>>> startSimulator('output.dac', 2, [0, 10, 20])
>>> # Starts simulation and generates an ASCII DAC file named 'output.dac' with output at 0, 10, and 20 days

See also

start_stimu

stopSimulator(): Stops the simulator after simulation run started with startSimulator().

stripSupermesh(): Remove the supermesh from a fem file.

submitPendingChanges()

timeStepIsRejected()

Test if the time step is rejected.

Returns:: True if an adaptive time step has been rejected and a solution has to be repeated with a reduced time step, False otherwise
Return type:: bool

updateElementExtents(): Update FEFLOW’s internal cache of element extents Call IfmUpdateElementExtensts() after changing the geometry of the FEM mesh to update the element extents.

See also

getNode, getElement, getOriginX, getOriginY, getOriginZ, getExtentX, getExtentY, getExtentZ, getExtents, getX, getY, getZ, setX, setY, setZ, updateElementExtents, getZValueAtXYSlice, getNumberOfBorders, getNumberOfBorderNodes, getBorderNode, isExteriorBorder, deleteFiniteElements, allowNodeMovement, meshSmoothing, getGravityDirection, getExchangeThicknessAtNode3D, findElementAtXY, findElementAtXYZ, findNodeAtXY, findNodeAtXYZ, getNextElement2D, getNextNode2D, enableSpatialIndex, getElementDiameter, getNumberOfEdges, getEdgeNodes, queryEdgeElements, getNumberOfFaces, getFaceNodes, queryFaceElements, setGeoCoordinateSystem, getGeoCoordinateSystem