classes.conditionCreator.ConditionCreator Class Reference

Extends KratosClassCreator for a Kratos Condition. More...

Inheritance diagram for classes.conditionCreator.ConditionCreator:

Collaboration diagram for classes.conditionCreator.ConditionCreator:

Public Member Functions
def	__init__ (self, name, base='Condition', template=None, members=None, procedures=None, author='KratosAppGenerator')
def	AddFlags (self, flagList)
	Adds a list of flags to the condition and initializes. More...
def	AddDofs (self, dofList)
	Adds a list of dofs to the condition and initializes. More...
Public Member Functions inherited from classes.classCreator.ClassCreator
def	AddClassMemberVariables (self, members)
	Adds a list of class member variables to the class and initializes them in case it is possible. More...
def	AddProcudures (self, procedures)
Public Member Functions inherited from utils.templateRule.TemplateRule
def	__init__ (self)
def	GetRule (self, ruleName)

Additional Inherited Members
Public Attributes inherited from classes.classCreator.ClassCreator
	author
	nameCamel
	nameUpper
	nameLower
	baseHead
	base
	template
	procedures
Public Attributes inherited from utils.templateRule.TemplateRule
	rules

Detailed Description

Extends KratosClassCreator for a Kratos Condition.

It expects a condition_template.cpp and condition_template.h as base file.

Input

• name: string name of the class
• base: string name of the base condition, if any. Defaults to 'Condition'.
• template:: instance of KratosTemplate not yet implemented.
• members: list of KratosClassMember class members to be added.
• procedures: list of KratosClassProcedures class procedures to be added. NYI

Output

• Instance of a KratosConditionCreator

Rules

• KRATOS_CLASS_LOCAL_FLAGS}: The flag list
• KRATOS_CONDITION_LIST_DOFS}: The dof list
• KRATOS_CONDITION_EQUATION_ID_DOFS}: The dof list for the equation id's

Constructor & Destructor Documentation

__init__()

def classes.conditionCreator.ConditionCreator.__init__	(		self,
			name,
			base = 'Condition',
			template = None,
			members = None,
			procedures = None,
			author = 'KratosAppGenerator'
	)

Reimplemented from classes.classCreator.ClassCreator.

Member Function Documentation

AddDofs()

def classes.conditionCreator.ConditionCreator.AddDofs	(		self,
			dofList
	)

Adds a list of dofs to the condition and initializes.

It is guaranteed that the order of the list will be respected.

Input

• dofList: list of strings the list of dof names to be added

Output

• returns itself to allow chaining

Rules

• KRATOS_CONDITION_LIST_DOFS}: The dof list
• KRATOS_CONDITION_EQUATION_ID_DOFS}: The dof list for the equation id's

AddFlags()

def classes.conditionCreator.ConditionCreator.AddFlags	(		self,
			flagList
	)

Adds a list of flags to the condition and initializes.

       Input
       -----
       - flagList: list of strings
           the list of flag names to be added

       Output
       ------
       - returns itself to allow chaining

       Rules
       -----
       - @{KRATOS_CLASS_LOCAL_FLAGS}:
           The flag list

---

The documentation for this class was generated from the following file:

• /home/runner/work/Documentation/Documentation/master/kratos/python_scripts/application_generator/classes/conditionCreator.py