proteus.BoundaryConditions module

class proteus.BoundaryConditions.BC_Base(shape=None, name=None, b_or=None, b_i=0, nd=None)[source]

Bases: object

Generic class regrouping boundary conditions

BC_type[source]

str

Type

BC_type

Shape[source]

object

Type

Shape

ct[source]

object

Type

ct

getContext[source]

Gets context from proteus.Context or

Parameters

context (class, optional) – if set to None, the context will be created from proteus.Context

name[source]

str

Type

name

nd[source]

‘int’

Type

nd

class proteus.BoundaryConditions.BoundaryCondition[source]

Bases: object

Boundary condition class

Variables

uOfXT (func or None) – boundary condition function of x (array_like) and t (float) or None for no boundary condition

init_cython[source]
resetBC[source]
setConstantBC[source]

function returning constant BC

Parameters

value (float) – Constant value

setLinearBC[source]

function returning value=a0+ax*x+ay*y+az*z

Parameters
  • a0 (float) – constant

  • a (numpy.ndarray) – ax,ay,az

setLinearRamp[source]

function setting a linear ramp from t=0 to t=t1

Parameters
  • t1 (float) – Ramp end time

  • value (float) – Variable value

uOfXT[source]

object

Type

uOfXT