d3f_util.orig.lua File Reference

Functions
function util d3f	AdvectLSF (step, t, dt, inst, vol, coef)
function util d3f	ComputeFluxByDefect (inst, problem)
function util d3f	ComputeFSHeight (step, inst, time)
function util d3f	ComputeFSVolume (step, inst, vol, time)
function util d3f	ComputePressureApprox (inst, problem)
function util d3f	ComputeSDF (inst, step)
function util d3f	ConvertTableDataToExplicitFormat (node)
function util d3f	CreateBoundaryConditions (inst, vol, flow)
function util d3f	CreateDirichletBoundary (inst, vol, b)
function util d3f	CreateFlowDiscs (inst, vol, flow)
function util d3f	CreateFlowDiscs_Haline (inst, vol, flow)
function util d3f	CreateFlowDiscs_Prescribed (inst, vol, flow)
function util d3f	CreateFlowDiscs_PressureDriven (inst, vol, flow)
function util d3f	CreateFlowDiscs_Thermohaline (inst, vol, flow)
function util d3f	CreateInOutflowBoundary (inst, flow, b)
function util d3f	CreateNeumannBoundary (inst, vol, b, boussinesq)
function util d3f	CreateOutflowBoundary (inst, flow, b)
function util d3f	CreateOutputFct (inst, problem, coef)
function util d3f	CreateRiverRechargeObject (problem, fs_river_network, lsf)
function util d3f	CreateSpaces (inst, vol, flow)
function util d3f	CreateTransBoundaryConditions (inst, vol, bnd)
function util d3f	CreateTransInOutflowBoundary (inst, vol, b)
function util d3f	CreateTransOutflowBoundary (inst, vol, b)
function util d3f	CreateTransportDiscs (inst, vol, trans)
function	d3fLimexLuaCallbackPre (step, t, currdt)
function	DDensitySeparationTFct_T (TC)
function util d3f parse	Density (DensityDesc, w)
function util d3f check	exist (param, name)
function util d3f	ExtractParameter (vol, sec, node, param, cmp)
function util d3f	ExtractSubsetInfoFromDomain (subsets, dom)
function util d3f	ExtractSubsetWithDimension (vol, subsets, dim)
function	get (x, y, z, t)
function util d3f parse	Gravity (GravityDesc)
function util d3f	InitLSF (inst, problem)
function	Kroehn_T (TC)
function	LuaExitIf (pred, msg)
function	PorosityExp_p (p)
function util d3f	PostProcessRoutines (vol, inst, problem, coef)
function util d3f	PrepareFractures (vol, inst, problem)
function util d3f	PrepareLSF (step, inst, vol, coef, time)
function util d3f	PreProcessRoutines (vol, inst, problem, coef)
function util d3f	ResetFlowDiscsForLIMEX (vol, damp, mask)
function util d3f	RewindLSF (step, inst)
function util d3f	RewindStepRoutines (vol, inst, problem, coef)
function util d3f	SetCalciteStartValue (transport, calcite, start)
function util d3f	SetFlowStartValues (flow, u, start)
function util d3f	SetFSBoundaryCond (inst, problem, cmp, bc_kind, bc_val)
function util d3f	SetRockMatrixProperties (vol, tElements, cmp)
function util d3f	SetTransportStartValues (transport, u, start)
function util d3f	SetUpFreeSurfaceData (inst, problem, domain, vol)
function	SubsetPorosity3d (x, y, z, t, si)
function util d3f check	type (param, name, typ)
function util d3f parse	Upwind (upwind)
function util d3f	usage ()
function util d3f parse	Viscosity (ViscosityDesc, w)

Variables
parameterNumber	fromCP = 0
	id of the checkpoint

Function Documentation

AdvectLSF()

function util d3f AdvectLSF	(	step	,
		t	,
		dt	,
		inst	,
		vol	,
		coef
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :873-936

ComputeFluxByDefect()

function util d3f ComputeFluxByDefect	(	inst	,
		problem
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3348-3387

References if().

ComputeFSHeight()

function util d3f ComputeFSHeight	(	step	,
		inst	,
		time
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :728-740

function util.d3f.ComputeFSHeight (step, inst, time)
  if inst.free_surface_present then
    if inst.fs_height_measurer ~= nil then
      inst.fs_height_measurer:reinit ()
    end
    
    if inst.fs_height_data ~= nil then
      inst.fs_height_data:reinit_for (inst.fs_height_elem_dim)
    end
  end
end

ComputeFSVolume()

function util d3f ComputeFSVolume	(	step	,
		inst	,
		vol	,
		time
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :695-725

ComputePressureApprox()

function util d3f ComputePressureApprox	(	inst	,
		problem
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3698-3753

ComputeSDF()

function util d3f ComputeSDF	(	inst	,
		step
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :743-770

ConvertTableDataToExplicitFormat()

function util d3f ConvertTableDataToExplicitFormat

(

node

)

inserts for the table data the explicit items and removes the tabledata

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1883-1926

CreateBoundaryConditions()

function util d3f CreateBoundaryConditions	(	inst	,
		vol	,
		flow
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2707-2750

CreateDirichletBoundary()

function util d3f CreateDirichletBoundary	(	inst	,
		vol	,
		b
	)

Adds a dirichlet condition to the domain disc inst - table storing instances vol - table storing subset informations b - table specifying conditions, e.g. b = { cmp = "..", bnd = "..", value = ...}

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2498-2531

CreateFlowDiscs()

function util d3f CreateFlowDiscs	(	inst	,
		vol	,
		flow
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2844-2874

CreateFlowDiscs_Haline()

function util d3f CreateFlowDiscs_Haline	(	inst	,
		vol	,
		flow
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2208-2411

CreateFlowDiscs_Prescribed()

function util d3f CreateFlowDiscs_Prescribed	(	inst	,
		vol	,
		flow
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2474-2492

function util.d3f.CreateFlowDiscs_Prescribed(inst, vol, flow)
 
  for _, v in pairs(vol) do v.flow.type = "prescribed" end
  util.d3f.ExtractParameter(vol, "flow", flow, "value")
  
  
  for subset, data in pairs(vol) do   
  
      local v = data.flow
 
    v.darcy = v.value
    v.porosity = 0.2
  end 
end

CreateFlowDiscs_PressureDriven()

function util d3f CreateFlowDiscs_PressureDriven	(	inst	,
		vol	,
		flow
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2413-2472

CreateFlowDiscs_Thermohaline()

function util d3f CreateFlowDiscs_Thermohaline	(	inst	,
		vol	,
		flow
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2009-2205

CreateInOutflowBoundary()

function util d3f CreateInOutflowBoundary	(	inst	,
		flow	,
		b
	)

Adds a in/out condition to the domain disc inst - table storing instances flow - table storing flow parameters b - table specifying conditions, e.g. b = { cmp = "..", bnd = "..", value = ...}

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2668-2704

CreateNeumannBoundary()

function util d3f CreateNeumannBoundary	(	inst	,
		vol	,
		b	,
		boussinesq
	)

Adds a neumann condition to the domain disc inst - table storing instances vol - table storing subset informations b - table specifying conditions, e.g. b = { cmp = "..", bnd = "..", value = ...} boussinesq - whether boussinesq approximation is used

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2539-2622

CreateOutflowBoundary()

function util d3f CreateOutflowBoundary	(	inst	,
		flow	,
		b
	)

Adds a out condition to the domain disc inst - table storing instances flow - table storing flow parameters b - table specifying conditions, e.g. b = { cmp = "..", bnd = "..", value = ...}

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2630-2661

CreateOutputFct()

function util d3f CreateOutputFct	(	inst	,
		problem	,
		coef
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3981-4407

CreateRiverRechargeObject()

function util d3f CreateRiverRechargeObject	(	problem	,
		fs_river_network	,
		lsf
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :131-205

CreateSpaces()

function util d3f CreateSpaces	(	inst	,
		vol	,
		flow
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2878-2931

References for().

CreateTransBoundaryConditions()

function util d3f CreateTransBoundaryConditions	(	inst	,
		vol	,
		bnd
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2813-2841

CreateTransInOutflowBoundary()

function util d3f CreateTransInOutflowBoundary	(	inst	,
		vol	,
		b
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2780-2811

CreateTransOutflowBoundary()

function util d3f CreateTransOutflowBoundary	(	inst	,
		vol	,
		b
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2752-2778

CreateTransportDiscs()

function util d3f CreateTransportDiscs	(	inst	,
		vol	,
		trans
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :2934-3221

References for(), and if().

d3fLimexLuaCallbackPre()

function d3fLimexLuaCallbackPre	(	step	,
		t	,
		currdt
	)

/**

/** location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :5168-5375

References for(), and if().

DDensitySeparationTFct_T()

function DDensitySeparationTFct_T

(

TC

)

This function creates a UserData for the density, based on the passed density descriptor

DensityDesc
w
T

/**

/**

/**

/**

/**

/**

/**

/**

/**

/** location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1234-1268

Density()

function util d3f parse Density	(	DensityDesc	,
		w
	)

This function creates a UserData for the density, based on the passed density descriptor

DensityDesc
w

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :963-1026

References for(), and if().

exist()

function util d3f check exist	(	param	,
		name
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :107-115

function util.d3f.check.exist(param, name)
 
  if param == nil then
    print("In util.d3f.solve: Required parameter '"..name.."' not specified.");
    util.d3f.usage();
    print("Check parameter settings. Aborting execution."); exit();
  end
 
end

ExtractParameter()

function util d3f ExtractParameter	(	vol	,
		sec	,
		node	,
		param	,
		cmp
	)

vol
sec
node
param
cmp

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1937-1976

ExtractSubsetInfoFromDomain()

function util d3f ExtractSubsetInfoFromDomain	(	subsets	,
		dom
	)

This function extracts name and dimension from the domain subsets - a lua-table (on entry empty) that is filled by subset names and dimensions dom - the domain

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1846-1859

function util.d3f.ExtractSubsetInfoFromDomain(subsets, dom)
 
  if type(subsets) ~= "table" then print("Expected lua table."); exit(); end
 
  subsets.name  = {}
  subsets.dim   = {}
 
  for i = 0, dom:domain_info():num_subsets()-1 do
    subsets.name[i]  = dom:subset_handler():get_subset_name(i)  
    subsets.dim[i]   = dom:domain_info():subset_dim(i) 
  end
end

ExtractSubsetWithDimension()

function util d3f ExtractSubsetWithDimension	(	vol	,
		subsets	,
		dim
	)

This function creates table where keys are of subset name for subsets of a given dimension subsets - a lua-table (on entry empty) that is filled by subset names and dimensions dom - the domain

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1865-1880

function util.d3f.ExtractSubsetWithDimension(vol, subsets, dim)
 
  if type(subsets) ~= "table" then print("Expected lua table."); exit(); end
  if type(vol) ~= "table"   then print("Expected lua table."); exit(); end
  if type(dim) ~= "number"  then print("Expected number."); exit(); end
 
  for k,_ in pairs(vol) do vol[k] = nil end
 
  for i, name in pairs(subsets.name) do
    if subsets.dim[i] == dim then
      vol[name] = {}
    end
  end
end

get()

function get	(	x	,
		y	,
		z	,
		t
	)

Based on the passed permeability descriptor, this function creates a table which contains a UserData and callbacks for the permeability. It either accepts a number value or a table with the following entries: { file,
interpolationOrder,

blurAlpha,

blurIterations,

}

The following table is returned { userData,
get(x,y,t)
get(x,y,z,t)
}

permDesc

/**

/** location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1718-1753

/**

/** location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1775-1802

Referenced by ug::d3f::ThermohalineFlow< TDomain >::add_def_A_elem(), ug::NavierStokes::NavierStokesSymBCFV1< TDomain >::add_def_A_elem(), ug::NavierStokes::CRNavierStokesSymBC< TDomain >::add_def_A_elem(), ug::d3f::ThermohalineFlow< TDomain >::add_def_M_elem(), ug::d3f::ThermohalineFlow< TDomain >::add_jac_A_elem(), ug::NavierStokes::NavierStokesSymBCFV1< TDomain >::add_jac_A_elem(), ug::NavierStokes::CRNavierStokesSymBC< TDomain >::add_jac_A_elem(), ug::d3f::ThermohalineFlow< TDomain >::add_jac_M_elem(), ug::d3f::OutFlowBC< TDomain, TAlgebra >::adjust_defect(), ug::d3f::InOutFlowBC< TDomain, TAlgebra >::adjust_defect(), ug::d3f::OutFlowBC< TDomain, TAlgebra >::adjust_jacobian(), ug::d3f::InOutFlowBC< TDomain, TAlgebra >::adjust_jacobian(), ug::d3f::RiverSSSManager< TDomain, TAlgebra >::cache_interface_elements(), ug::Electromagnetism::EMaterial< TDomain >::connectivity(), ug::CRMinimumDegree(), ug::CRSloan(), ug::d3f::RiverSSSManager< TDomain, TAlgebra >::evaluate_exchange_flux(), ug::d3f::FractDDF_FV1< TDomain >::ex_brine(), ug::d3f::FractTHF_FV1< TDomain >::ex_brine(), ug::d3f::ThermohalineFlow< TDomain >::ex_brine(), ug::d3f::DensityDrivenFlowFV1< TDomain >::ex_brine(), ug::d3f::ThermohalineFlow< TDomain >::ex_brine_grad(), ug::d3f::DensityDrivenFlowFV1< TDomain >::ex_brine_grad(), ug::d3f::ThermohalineFlow< TDomain >::ex_darcy_cons_grav(), ug::d3f::ThermohalineFlow< TDomain >::ex_darcy_std(), ug::ConvectionDiffusionPlugin::ConvectionDiffusionFV1< TDomain >::ex_grad(), ug::ConvectionDiffusionPlugin::ConvectionDiffusionFVCR< TDomain >::ex_grad(), ug::NavierStokes::NavierStokesFV1< TDomain >::ex_nodal_pressure(), ug::NavierStokes::NavierStokesFV1< TDomain >::ex_nodal_velocity(), ug::d3f::FractDDF_FV1< TDomain >::ex_pressure(), ug::d3f::FractTHF_FV1< TDomain >::ex_pressure(), ug::d3f::DensityDrivenFlowFV1< TDomain >::ex_pressure(), ug::d3f::ThermohalineFlow< TDomain >::ex_pressure_grad(), ug::d3f::DensityDrivenFlowFV1< TDomain >::ex_pressure_grad(), ug::NavierStokes::NavierStokesFV1< TDomain >::ex_pressure_grad(), ug::d3f::FractTHF_FV1< TDomain >::ex_temperature(), ug::d3f::ThermohalineFlow< TDomain >::ex_temperature(), ug::d3f::ThermohalineFlow< TDomain >::ex_temperature_grad(), ug::ConvectionDiffusionPlugin::ConvectionDiffusionFV1< TDomain >::ex_value(), ug::ConvectionDiffusionPlugin::ConvectionDiffusionFVCR< TDomain >::ex_value(), ug::NavierStokes::NavierStokesFV1< TDomain >::ex_velocity_grad(), ug::NavierStokes::NavierStokesFV1< TDomain >::ex_velocity_ip(), ug::NavierStokes::NavierStokesSymBCFV1< TDomain >::fsh_elem_loop(), ug::NavierStokes::CRNavierStokesSymBC< TDomain >::fsh_elem_loop(), ug::d3f::ThermohalineFlow< TDomain >::prep_elem(), ug::NavierStokes::NavierStokesSymBCFV1< TDomain >::prep_elem(), ug::NavierStokes::CRNavierStokesSymBC< TDomain >::prep_elem(), ug::d3f::ThermohalineFlow< TDomain >::prep_elem_loop(), ug::NavierStokes::NavierStokesSymBCFV1< TDomain >::prep_elem_loop(), ug::NavierStokes::CRNavierStokesSymBC< TDomain >::prep_elem_loop(), ug::ConvectionDiffusionPlugin::ConvectionDiffusionFV1< TDomain >::prep_err_est_elem(), ug::ConvectionDiffusionPlugin::ConvectionDiffusionFE< TDomain >::prep_err_est_elem_loop(), ug::ConvectionDiffusionPlugin::ConvectionDiffusionFV1< TDomain >::prep_err_est_elem_loop(), and ug::Electromagnetism::EddyCurrent_E_Nedelec< TDomain, TAlgebra >::prepare_element().

Gravity()

function util d3f parse Gravity

(

GravityDesc

)

This function creates a UserData for the gravity, based on the passed gravity descriptor

GravityDesc
w

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1643-1674

InitLSF()

function util d3f InitLSF	(	inst	,
		problem
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :773-819

Kroehn_T()

function Kroehn_T

(

TC

)

This function creates a UserData for the viscosity, based on the passed viscosity descriptor

ViscosityDesc
w
T

/**

/**

/**

/**

/**

/** location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1582-1612

LuaExitIf()

function LuaExitIf	(	pred	,
		msg
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1928-1930

function LuaExitIf(pred, msg)
  if (pred) then print(msg); exit(); end
end

PorosityExp_p()

function PorosityExp_p

(

p

)

This function creates a UserData for the porosity, based on the passed porosity descriptor

PorosityDesc
p

/**

/** location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1329-1348

   function PorosityExp_p(p)
      return alpha * (1.0 - phi_ref) * math.exp(-alpha *(p - p_ref))
   end
 
   porosity = LuaUserFunctionNumber("PorosityExp", 1)
   porosity:set_deriv(0, "PorosityExp_p");
   porosity:set_input(0, p)
      end
 
   end
 
   if porosity == nil then
      print("Cannot create porosity from porosity descriptor")
      exit()
   end
 
   return porosity
 
end

PostProcessRoutines()

function util d3f PostProcessRoutines	(	vol	,
		inst	,
		problem	,
		coef
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3819-3975

PrepareFractures()

function util d3f PrepareFractures	(	vol	,
		inst	,
		problem
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3393-3427

References if().

PrepareLSF()

function util d3f PrepareLSF	(	step	,
		inst	,
		vol	,
		coef	,
		time
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :822-870

PreProcessRoutines()

function util d3f PreProcessRoutines	(	vol	,
		inst	,
		problem	,
		coef
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3759-3795

References if().

ResetFlowDiscsForLIMEX()

function util d3f ResetFlowDiscsForLIMEX	(	vol	,
		damp	,
		mask
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1809-1841

RewindLSF()

function util d3f RewindLSF	(	step	,
		inst
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :939-949

function util.d3f.RewindLSF (step, inst)
  if inst.free_surface_present then
    print ("Restoring the free surface...")
    inst.lsf:assign (inst.nv_old)
    inst.sdf_new:assign (inst.lsf)
    
    util.d3f.ComputeSDF (inst, step) --> instead of this
  end
end

RewindStepRoutines()

function util d3f RewindStepRoutines	(	vol	,
		inst	,
		problem	,
		coef
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3797-3817

References if().

SetCalciteStartValue()

function util d3f SetCalciteStartValue	(	transport	,
		calcite	,
		start
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3316-3346

SetFlowStartValues()

function util d3f SetFlowStartValues	(	flow	,
		u	,
		start
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3223-3275

References if().

SetFSBoundaryCond()

function util d3f SetFSBoundaryCond	(	inst	,
		problem	,
		cmp	,
		bc_kind	,
		bc_val
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :214-244

SetRockMatrixProperties()

function util d3f SetRockMatrixProperties	(	vol	,
		tElements	,
		cmp
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1978-2006

SetTransportStartValues()

function util d3f SetTransportStartValues	(	transport	,
		u	,
		start
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3277-3314

References if().

SetUpFreeSurfaceData()

function util d3f SetUpFreeSurfaceData	(	inst	,
		problem	,
		domain	,
		vol
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :247-692

SubsetPorosity3d()

function SubsetPorosity3d	(	x	,
		y	,
		z	,
		t	,
		si
	)

/**

/**

/**

/**

/**

/**

/**

/**

/**

/** location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :3524-3692

References if().

type()

function util d3f check type	(	param	,
		name	,
		typ
	)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :117-125

function util.d3f.check.type(param, name, typ)
 
  if type(param) ~= typ then
    print("In util.d3f.solve: Parameter '"..name.."' not a "..typ..".");
    util.d3f.usage();
    print("Check parameter settings. Aborting execution."); exit(); 
  end
 
end

Upwind()

function util d3f parse Upwind

(

upwind

)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1615-1637

usage()

function util d3f usage

(

)

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :86-99

function util.d3f.usage()
  print("");
  print("Usage of util.d3f.solve(problem):");
  print("---------------------------------");
  print("");
  print(" (r) = required, (o) = optional");
  print("");
  print("(r) problem.domain             -- a subsection ");
  print("(r) problem.domain.dim         -- World dimension of problem [1,2,3]");
  print("(r) problem.domain.grid        -- (path to) grid file [\"*.ugx\"]");
  print("(r) problem.domain.numRefs     -- number of refinements (integer)");
  print("(r) problem.domain.numPreRefs  -- number of pre-refinements (parallel) (integer)");
 
end

Viscosity()

function util d3f parse Viscosity	(	ViscosityDesc	,
		w
	)

This function creates a UserData for the viscosity, based on the passed viscosity descriptor

ViscosityDesc
w

location: /home/runner/work/docs/docs/ug4/plugins/d3f/lua/bak / d3f_util.orig.lua :1355-1426

Referenced by ug::d3f::ThermohalineFlow< TDomain >::compute_darcy_velocity_ip_std(), ug::d3f::FractDDF_FV1< TDomain >::compute_ip_Darcy_velocity(), ug::d3f::FractTHF_FV1< TDomain >::compute_ip_Darcy_velocity(), ug::d3f::DensityDrivenFlowFV< TDomain >::compute_ip_darcy_velocity_std(), ug::d3f::FractTHF_FV1< TDomain >::compute_J_ip_Darcy_velocity(), and ug::d3f::FractDDF_FV1< TDomain >::compute_J_ip_Darcy_velocity().

Variable Documentation

fromCP

parameterNumber fromCP = 0

id of the checkpoint