AbstractKernel
AbstractKernel_
class is an abstract class for designing kernels. You can see the structure of the AbstractKernel
here.
Constructor Methods
SetAbstractKernelParam
This method sets the essential parameters of the kernel. The user should use this method to set the parameters in the kernel. You can find more information here SetAbstractKernelParam.
CheckEssentialParam
It check the essential parameters of the kernel. This method is called internally to check the validity of the data while initiating the kernel. A general user should not worry about it. You can find more information here.
Initiate
This method reads the parameters and store them in the abstract kernel. This method is usually extended by the child classes. You can find more information here Initiate
Deallocate
This method deallocates the memory of the kernel. This method is usually extended by the child classes. You can find more information here Deallocate
PreCheckError
This method is called to check the errors in the kernel. This method is called before setting the kernel. This is also an internal method and a general user should not worry about it. You can find more information here PreCheckError.
PostCheckError
This method is called to check the errors in the kernel. This method is called after setting the kernel. This is also an internal method and a general user should not worry about it. This method is documented here.
CheckError
This method checks the errors in the Kernel. This method is called internally to check the validity of the data while initiating the kernel. A general user should not worry about it. You can find more information here.
Initiating fields
KernelInitiateSpaceMatrix
This subroutine is defined in KernelMatrixField_Method
. You can find about this subroutine here
KernelInitiateTangentMatrix
This subroutine is defined in KernelMatrixField_Method
. You can find about this subroutine here
InitiateFields
InitiateTangentMatrix
This subroutine initiate the tangent matrix of the kernel.
InitiateScalarFields
InitiateSTScalarFields
InitiateVectorFields
InitiateSTVectorFields
InitiateMatrixFields
All methods
📄️ Structure
AbstractKernel_ class is an abstract class for physics kernel.
📄️ AbstractKernelParam
This module contains options for 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.
📄️ CheckError
This method check the error in kernel.
📄️ CheckEssentialParam
Checks the essential parameters in the parameter list 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 reads the information from parameter list and stores them in the field of abstract kernel.
📄️ InitiateFields
This routine initiates the matrix and vector fields
📄️ InitiateTangetMatrix
This subroutine initiate the tangent matrix of the kernel.
📄️ IsConverged
This subroutine returns true if the iteration in the kernel is converged.
📄️ KernelAddDirichletBC
Add dirichlet boundary conditions.
📄️ KernelAddNeumannBC
Add Neumann boundary conditions.
📄️ KernelBC
This class deals with the boundary conditions in the kernel.
📄️ KernelElemshapeData
This class contains the information of the shape functions used in the kernel.
📄️ KernelFields
This class contains the fields for the kernel. It contains the following fields:
📄️ 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_.
📄️ KernelInitiateSpaceMatrix
This subroutine initiates the space matrix.
📄️ KernelInitiateTangentMatrix
This subroutine is defined in KernelMatrixField_Method.
📄️ KernelMaterials
This class contains the materials of the kernel.
📄️ KernelMeshFields
This class contains the mesh fields of the kernel.
📄️ KernelOpt
This class contains the options for the kernel.
📄️ PostCheckError
This method checks the error in the kernel after setting the kernel.
📄️ PreCheckError
This method check the error in kernel before setting it. This method can be extended by the child classes.
📄️ Run
Run the simulation.
📄️ Set
This subroutine sets the option of the kernel and build the kernel.
📄️ SetAbstractKernelParam
Set the kernel parameters in parameter list.
📄️ 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