Share
fipy.boundaryConditions package¶
Submodules¶
fipy.boundaryConditions.boundaryCondition module¶

class
fipy.boundaryConditions.boundaryCondition.
BoundaryCondition
(faces, value)¶ Bases:
object
Generic boundary condition base class.
Attention
This class is abstract. Always create one of its subclasses.
Parameters:  faces: A list or tuple of exterior Face objects to which this condition applies.
 value: The value to impose.
fipy.boundaryConditions.constraint module¶

class
fipy.boundaryConditions.constraint.
Constraint
(value, where=None)¶ Bases:
object
Object to hold a Variable to value at where
see
constrain()
fipy.boundaryConditions.fixedFlux module¶

class
fipy.boundaryConditions.fixedFlux.
FixedFlux
(faces, value)¶ Bases:
fipy.boundaryConditions.boundaryCondition.BoundaryCondition
The FixedFlux boundary condition adds a contribution, equivalent to a fixed flux (Neumann condition), to the equation’s RHS vector. The contribution, given by value, is only added to entries corresponding to the specified faces, and is weighted by the face areas.
Creates a FixedFlux object.
Parameters:  faces: A list or tuple of Face objects to which this condition applies.
 value: The value to impose.
fipy.boundaryConditions.fixedValue module¶

class
fipy.boundaryConditions.fixedValue.
FixedValue
(faces, value)¶ Bases:
fipy.boundaryConditions.boundaryCondition.BoundaryCondition
The FixedValue boundary condition adds a contribution, equivalent to a fixed value (Dirichlet condition), to the equation’s RHS vector and coefficient matrix. The contributions are given by for the RHS vector and for the coefficient matrix. The parameter represents the term’s geometric coefficient, which depends on the type of term and the mesh geometry.
Contributions are only added to entries corresponding to the specified faces.
Parameters:  faces: A list or tuple of exterior Face objects to which this condition applies.
 value: The value to impose.
fipy.boundaryConditions.nthOrderBoundaryCondition module¶

class
fipy.boundaryConditions.nthOrderBoundaryCondition.
NthOrderBoundaryCondition
(faces, value, order)¶ Bases:
fipy.boundaryConditions.boundaryCondition.BoundaryCondition
This boundary condition is generally used in conjunction with a ImplicitDiffusionTerm that has multiple coefficients. It does not have any direct effect on the solution matrices, but its derivatives do.
Creates an NthOrderBoundaryCondition.
Parameters:  faces: A list or tuple of Face objects to which this condition applies.
 value: The value to impose.
 order: The order of the boundary condition. An order of 0 corresponds to a FixedValue and an order of 1 corresponds to a FixedFlux. Even and odd orders behave like FixedValue and FixedFlux objects, respectively, but apply to higher order terms.
fipy.boundaryConditions.test module¶
Test numeric implementation of the mesh
Module contents¶

class
fipy.boundaryConditions.
Constraint
(value, where=None)¶ Bases:
object
Object to hold a Variable to value at where
see
constrain()

class
fipy.boundaryConditions.
FixedFlux
(faces, value)¶ Bases:
fipy.boundaryConditions.boundaryCondition.BoundaryCondition
The FixedFlux boundary condition adds a contribution, equivalent to a fixed flux (Neumann condition), to the equation’s RHS vector. The contribution, given by value, is only added to entries corresponding to the specified faces, and is weighted by the face areas.
Creates a FixedFlux object.
Parameters:  faces: A list or tuple of Face objects to which this condition applies.
 value: The value to impose.

class
fipy.boundaryConditions.
FixedValue
(faces, value)¶ Bases:
fipy.boundaryConditions.boundaryCondition.BoundaryCondition
The FixedValue boundary condition adds a contribution, equivalent to a fixed value (Dirichlet condition), to the equation’s RHS vector and coefficient matrix. The contributions are given by for the RHS vector and for the coefficient matrix. The parameter represents the term’s geometric coefficient, which depends on the type of term and the mesh geometry.
Contributions are only added to entries corresponding to the specified faces.
Parameters:  faces: A list or tuple of exterior Face objects to which this condition applies.
 value: The value to impose.

class
fipy.boundaryConditions.
NthOrderBoundaryCondition
(faces, value, order)¶ Bases:
fipy.boundaryConditions.boundaryCondition.BoundaryCondition
This boundary condition is generally used in conjunction with a ImplicitDiffusionTerm that has multiple coefficients. It does not have any direct effect on the solution matrices, but its derivatives do.
Creates an NthOrderBoundaryCondition.
Parameters:  faces: A list or tuple of Face objects to which this condition applies.
 value: The value to impose.
 order: The order of the boundary condition. An order of 0 corresponds to a FixedValue and an order of 1 corresponds to a FixedFlux. Even and odd orders behave like FixedValue and FixedFlux objects, respectively, but apply to higher order terms.
Version 3.1.3dev2g11937196
This Page
Quick search
Enter search terms or a module, class or function name.
Organizations
Contact
Join our mailing list, open an issue at the tracker, or ask a question on StackOverflow.