AbstractKernel
AbstractKernel_
class is an abstract class for designing kernels. You can see the structure of the AbstractKernel
here.
Methods
Constructor Methods
Set Methods
Get methods
All methods
📄️ Structure
AbstractKernel_ class is an abstract class for physics kernel.
📄️ Assemble
This subroutine assembles the system of linear equation.
📄️ AssembleRHS
This subroutine assembles the right-hand side vector for solving linear equation.
📄️ AssembleTanmat
This subroutine assembles the tangent matrix.
📄️ CheckEssentialParam
Checks the essential parameters in the param of kernels
📄️ Deallocate
This subroutine deallocates the data stored inside the Kernel
📄️ Display
This routine displays the content of kernel.
📄️ Export
This routine exports the kernel.
📄️ GetPrefix
Get the prefix of the kernel. This method should be implemented by the subclass.
📄️ Import
This routine initiates the kernel from input file
📄️ Initiate
This routine initiates the kernel, this method should be implemented by the children of AbstractKernel_:
📄️ InitiateFields
This routine initiates the matrix and vector fields
📄️ IsConverged
This subroutine returns true if the iteration in the kernel is converged.
📄️ KernelAddDirichletBC
Add dirichlet boundary conditions.
📄️ KernelAddNeumannBC
Add Neumann boundary conditions.
📄️ KernelGetCoordinateSystemID
📄️ KernelGetCoordinateSystemName
📄️ KernerlGetNSDFromID
📄️ KernelGetNSDFromName
📄️ KernelInitiateFromParam
This routine initiates the kernel by reading the basic parameters, if they are present. This routine can be used by children to set the data defined in AbstractKernel_.
📄️ Run
Run the simulation.
📄️ Set
This subroutine sets the option of the kernel and build the kernel.
📄️ SetAbstractKernelParam
Set kernel parameters
📄️ SetCurrentTimeStep
Set the current time step of simulation.
📄️ SetFacetFiniteElement
This routine sets the facet finite elements in the AbstractKernel_
📄️ SetFiniteElement
This routine sets the finite element in the AbstractKernel_
📄️ SetGlobalElemShapeDataInSpace
📄️ SetGlobalElemShapeDataInTime
📄️ SetIterationNumber
Set the current iteration number of simulation.
📄️ SetLocalElemShapeDataInTime
📄️ SetLocalElemShapeDataInSpace
📄️ SetFiniteElement
This routine sets the finite element data in the AbstractKernel_
📄️ SetQuadPointsInSpace
📄️ SetQuadPointsInTime
📄️ Update
This subroutine update the state of the kernel.
📄️ UpdateIteration
This subroutine update the state of the kernel after an iteration.
📄️ WriteData
This routine writes the data in the HDF5File