Peano

Searching...

No Matches

Fixed boundary conditions. More...

Inheritance diagram for swift2.api.boundaryconditions.Fixed.Fixed:

[legend]

Collaboration diagram for swift2.api.boundaryconditions.Fixed.Fixed:

[legend]

Public Member Functions
	__init__ (self, particle_set, relative_domain_halo=0.1)
	Fixed boundary condition.
	get_action_set_name (self)
	Return unique action set name.
	get_body_of_operation (self, operation_name)
	Return actual C++ code snippets to be inserted into C++ code.
	user_should_modify_template (self)
	Is the user allowed to modify the output.
	get_includes (self)
	Return include statements that you need.
	get_constructor_body (self)
	Define a tailored constructor body.
	get_attributes (self)
	Return attributes as copied and pasted into the generated class.
Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
	__init__ (self, descend_invocation_order=0, parallel=False)
	get_static_initialisations (self, full_qualified_classname)
	get_destructor_body (self)
	get_body_of_getGridControlEvents (self)
	get_body_of_prepareTraversal (self)
	get_body_of_unprepareTraversal (self)

Data Fields
dict	d = {}
Data Fields inherited from peano4.solversteps.ActionSet.ActionSet
	descend_invocation_order = descend_invocation_order
	parallel = parallel

Static Private Attributes
	__Template_TouchVertexLastTime

Additional Inherited Members
Static Public Attributes inherited from peano4.solversteps.ActionSet.ActionSet
str	OPERATION_BEGIN_TRAVERSAL = "beginTraversal"
str	OPERATION_END_TRAVERSAL = "endTraversal"
str	OPERATION_CREATE_PERSISTENT_VERTEX = "createPersistentVertex"
str	OPERATION_DESTROY_PERSISTENT_VERTEX = "destroyPersistentVertex"
str	OPERATION_CREATE_HANGING_VERTEX = "createHangingVertex"
str	OPERATION_DESTROY_HANGING_VERTEX = "destroyHangingVertex"
str	OPERATION_CREATE_PERSISTENT_FACE = "createPersistentFace"
str	OPERATION_DESTROY_PERSISTENT_FACE = "destroyPersistentFace"
str	OPERATION_CREATE_HANGING_FACE = "createHangingFace"
str	OPERATION_DESTROY_HANGING_FACE = "destroyHangingFace"
str	OPERATION_CREATE_CELL = "createCell"
str	OPERATION_DESTROY_CELL = "destroyCell"
str	OPERATION_TOUCH_VERTEX_FIRST_TIME = "touchVertexFirstTime"
str	OPERATION_TOUCH_VERTEX_LAST_TIME = "touchVertexLastTime"
str	OPERATION_TOUCH_FACE_FIRST_TIME = "touchFaceFirstTime"
str	OPERATION_TOUCH_FACE_LAST_TIME = "touchFaceLastTime"
str	OPERATION_TOUCH_CELL_FIRST_TIME = "touchCellFirstTime"
str	OPERATION_TOUCH_CELL_LAST_TIME = "touchCellLastTime"

Detailed Description

Fixed boundary conditions.

Impose fixed boundary conditions within an action set. Such an action set can be injected into each and every grid sweep. Swift's generic boundary condition remarks discuss this realisation variant. It is quite heavy-weight and can yield invalid states prior to the very first time step.

The action set is used by adding it after you have lowered the Swift 2 formalism into a Peano 4 project:

project.additional_action_sets_per_solver_step.append(
swift2.api.boundaryconditions.Fixed(particle_set=particle_set, 
                                    damp_particles_as_they_approach_boundary=True
                                    )
)

Parameters

particle_set	swift2.particle.Particle The particle set for which we implement the boundary conditions.
relative_domain_halo	Positive float smaller than 0.5 The relative boundary in which we actually check particles at all. This one refers to the cells adjacent to the boundary. So if you pass in a 0.1, it means that 10% of this cell will next to the boundary will actually be read as "on the boundary".
damp_particles_as_they_approach_boundary	Boolean

Definition at line 8 of file Fixed.py.

Constructor & Destructor Documentation

◆ init()

swift2.api.boundaryconditions.Fixed.Fixed.__init__	(	self,
		particle_set,
		relative_domain_halo = 0.1 )

Fixed boundary condition.

Fixed boundary conditions are very difficult to impose within SPH. This is a very simplistic realisation of fixed boundary conditions, where particles are forced to come to rest once they approach the domain boundary.

Definition at line 43 of file Fixed.py.

References __init__().

Referenced by __init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

swift2.api.boundaryconditions.Fixed.Fixed.get_action_set_name ( self )

Return unique action set name.

Returns a description (word) for the mapping which is also used as class name for the generated type. As a consequence, the result should be one word (if possible) and uppercase. Also, every subclass should overwrite this routine.

The generator will take the result and construct eventually classes similar to MyStep2Dummy.h and MyStep2Dummy.cpp or similar for the example below, where we return Dummy.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 64 of file Fixed.py.

◆ get_attributes()

swift2.api.boundaryconditions.Fixed.Fixed.get_attributes ( self )

Return attributes as copied and pasted into the generated class.

Please note that action sets are not persistent, i.e. there is one object creation per grid sweep per tree.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 115 of file Fixed.py.

◆ get_body_of_operation()

swift2.api.boundaryconditions.Fixed.Fixed.get_body_of_operation	(		self,
			operation_name )

Return actual C++ code snippets to be inserted into C++ code.

See class' string constants starting with OPERATION_ for possible values of operation_name.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 85 of file Fixed.py.

◆ get_constructor_body()

swift2.api.boundaryconditions.Fixed.Fixed.get_constructor_body ( self )

Define a tailored constructor body.

By default, the constructor of an action set is empty. If you you assign attributes to your action set, you however might want to initialise them here. We do not support initialisation lists, to all has to be done via setters unless you create attributes on the heap.

The constructor's signature will look similar to

   EnumerateAndInitSolution2petsc_actionsets_InitVertexDoFs0(int treeNumber);

where the treeNumber is -1 if this is the global instance of the action set owned by a rank, or a number greater or equal 0 if this action set is a clone of the glocal action set that's used by one tree traversal.

See also: get_attributes() to add attributes to your action set

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 107 of file Fixed.py.

References get_constructor_body().

Referenced by get_constructor_body().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_includes()

swift2.api.boundaryconditions.Fixed.Fixed.get_includes ( self )

Return include statements that you need.

All of these includes will eventually end up in the header of the generated C++ code.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 94 of file Fixed.py.

◆ user_should_modify_template()

swift2.api.boundaryconditions.Fixed.Fixed.user_should_modify_template ( self )

Is the user allowed to modify the output.

Return whether you expect the user to modify the generated code. If this is the case, then the API places the generated output in the directory actions. Otherwise, it goes into the observer directory and will be overwritten in each and every Python run.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 91 of file Fixed.py.

Field Documentation

◆ __Template_TouchVertexLastTime

swift2.api.boundaryconditions.Fixed.Fixed.__Template_TouchVertexLastTime

staticprivate

Initial value:

=  jinja2.Template(
        
    )

Definition at line 67 of file Fixed.py.

Referenced by get_body_of_operation().

◆ d

swift2.api.boundaryconditions.Fixed.Fixed.d = {}

Definition at line 58 of file Fixed.py.

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

python/swift2/api/boundaryconditions/Fixed.py

Public Member Functions

Data Fields

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_operation()

◆ get_constructor_body()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ __Template_TouchVertexLastTime

◆ d

◆ init()