cgf – SelfForce1D

type, public, extends(gf) :: cgf

A complex data instance of the abstract grid function class.

Inherits

Inherited by

Components

Type	Visibility	Attributes		Name
integer(kind=ip),	public		::	n	The number of elements.
character(len=:),	public,	allocatable	::	vname	The name of the grid function.
integer(kind=ip),	public		::	io_id	The file unit used for output of this grid function.
type(element_cdata),	public,	dimension(:), allocatable	::	elems	A 1d array of the complex element data class.

Constructor

public interface cgf

The constructor for a complex data type grid function.

public interface init_cgf()

Arguments
None

Finalization Procedures

final :: deallocate_cgf

The finalizer.

public interface deallocate_cgf()

Arguments
None

Type-Bound Procedures

procedure, public, non_overridable :: output => output_cgf

Generic type bound procedure for output.

interface

public module subroutine output_cgf(this, coord)

The interface for an output routine for a complex data type grid function.

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	Has to be called with an cgf class.
type(rgf),	intent(in)			::	coord	A real grid function that contains the coordinates.

procedure, public, non_overridable :: copy => copy_cgf

Generic type bound procedure for copying the data from one complex grid function to another.

interface

public module subroutine copy_cgf(this, gf)

The interface for a procedure for copying the data from one complex grid function to another.

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
class(cgf),	intent(in)			::	gf	The grid function to copy.

procedure, public, non_overridable :: zero => zero_cgf

Generic type bound procedure for setting a complex grid function to zero.

interface

public module subroutine zero_cgf(this)

The interface for a procedure for setting a complex grid function to zero.
Read more…
Arguments

Type Intent Optional Attributes Name

class(cgf), intent(inout) :: this
The routine is called on this object.

procedure, public, non_overridable :: mult_sc => mult_sc_cgf

Generic type bound procedure for multplying a complex grid function with a real scalar.

interface

public module subroutine mult_sc_cgf(this, scalar)

The interface for a procedure for multplying a complex grid function with a real scalar.

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
real(kind=wp),	intent(in)			::	scalar	The scalar to multiply with.

procedure, public, non_overridable :: sc_mult_gf => sc_mult_gf_cgf

Generic type bound procedure for multplying a complex grid function with a real scalar and storing the result in another complex grid function.

interface

public module subroutine sc_mult_gf_cgf(this, scalar, gf)

The interface for a procedure for multplying a complex grid function with a real scalar and storing the result in another complex grid function.

Arguments

Type	Intent		Name
class(cgf),	intent(inout)	::	this	The routine is called on this object.
real(kind=wp),	intent(in)	::	scalar	The scalar to multiply with.
class(cgf),	intent(in)	::	gf	The grid function to multiply with.

procedure, public, non_overridable :: add_gf => add_gf_cgf

Generic type bound procedure for adding 2 complex grid functions together and storing the result in the first one.

interface

public module subroutine add_gf_cgf(this, gf)

The interface for a procedure for adding 2 complex grid functions together and storing the result in the first one.

Arguments

Type	Intent	Optional	Attributes		Name
class(cgf),	intent(inout)			::	this	The routine is called on this object.
class(cgf),	intent(in)			::	gf	The grid function to add.

procedure, public, non_overridable :: add_sc_mult_gf => add_sc_mult_gf_cgf

Generic type bound procedure adding together a grid function and a scalar multiplying another grid function and storing the result in the first one.

interface

public module subroutine add_sc_mult_gf_cgf(this, scalar, gf)

The interface for a procedure adding together a grid function and a scalar multiplying another grid function and storing the result in the first one.

Arguments

Type	Intent		Name
class(cgf),	intent(inout)	::	this	The routine is called on this object.
real(kind=wp),	intent(in)	::	scalar	The scalar to multiply with.
class(cgf),	intent(in)	::	gf	The second grid function.

procedure, public, non_overridable :: mult_sc_add_sc_mult_gf => mult_sc_add_sc_mult_gf_cgf

Generic type bound procedure for adding together a scalar multiplying a grid function with another scalar multiplying another grid function and storing the result in the first one.

interface

public module subroutine mult_sc_add_sc_mult_gf_cgf(this, scalar1, scalar2, gf)

The interface for a procedure for adding together a scalar multiplying a grid function with another scalar multiplying another grid function and storing the result in the first one.

Arguments

Type	Intent		Name
class(cgf),	intent(inout)	::	this	The routine is called on this object.
real(kind=wp),	intent(in)	::	scalar1	The first scalar.
real(kind=wp),	intent(in)	::	scalar2	The second scalar.
class(cgf),	intent(in)	::	gf	The second grid function.

procedure, public, non_overridable :: gf1_plus_sc_mult_gf2 => gf1_plus_sc_mult_gf2_cgf

Generic type bound procedure for storing the result of adding a second grid function with a scalar multiplying a third grid function in a grid function.

interface

public module subroutine gf1_plus_sc_mult_gf2_cgf(this, gf1, scalar, gf2)

The interface for a procedure for storing the result of adding a second grid function with a scalar multiplying a third grid function in a grid function.

Arguments

Type	Intent		Name
class(cgf),	intent(inout)	::	this	The routine is called on this object.
class(cgf),	intent(in)	::	gf1	The second grid function.
real(kind=wp),	intent(in)	::	scalar	The scalar.
class(cgf),	intent(in)	::	gf2	The third grid function.

procedure, public, non_overridable :: sc_mult_gf1_plus_sc_mult_gf2 => sc_mult_gf1_plus_sc_mult_gf2_cgf

Generic type bound procedure for storing the result of adding a scalar multiplying a second grid function with another scalar multiplying a third grid function in a grid function.

interface

public module subroutine sc_mult_gf1_plus_sc_mult_gf2_cgf(this, gf1, scalar1, gf2, scalar2)

The interface for a procedure for storing the result of adding a scalar multiplying a second grid function with another scalar multiplying a third grid function in a grid function.

Arguments

Type	Intent		Name
class(cgf),	intent(inout)	::	this	The routine is called on this object.
class(cgf),	intent(in)	::	gf1	The second grid function.
real(kind=wp),	intent(in)	::	scalar1	The first scalar.
class(cgf),	intent(in)	::	gf2	The third grid function.
real(kind=wp),	intent(in)	::	scalar2	The second scalar.

Source Code

  type, extends(gf) :: cgf
  !! A complex data instance of the abstract grid function class.
    type(element_cdata), dimension(:), allocatable :: elems
    !! A 1d array of the complex element data class.
    contains
      procedure, non_overridable :: output => output_cgf
      !! Generic type bound procedure for output.
      procedure, non_overridable :: copy => copy_cgf
      !! Generic type bound procedure for copying the data from one complex
      !! grid function to another.
      procedure, non_overridable :: zero => zero_cgf
      !! Generic type bound procedure for setting a complex grid function
      !! to zero.
      procedure, non_overridable :: mult_sc => mult_sc_cgf
      !! Generic type bound procedure for multplying a complex grid function
      !! with a real scalar.
      procedure, non_overridable :: sc_mult_gf => sc_mult_gf_cgf
      !! Generic type bound procedure for multplying a complex grid function
      !! with a real scalar and storing the result in another complex
      !! grid function.
      procedure, non_overridable :: add_gf => add_gf_cgf
      !! Generic type bound procedure for adding 2 complex grid functions
      !! together and storing the result in the first one.
      procedure, non_overridable :: add_sc_mult_gf => add_sc_mult_gf_cgf
      !! Generic type bound procedure adding together a grid function and
      !! a scalar multiplying another grid function and storing the result
      !! in the first one.
      procedure, non_overridable :: mult_sc_add_sc_mult_gf => mult_sc_add_sc_mult_gf_cgf
      !! Generic type bound procedure for adding together a scalar multiplying
      !! a grid function with another scalar multiplying another grid function
      !! and storing the result in the first one.
      procedure, non_overridable :: gf1_plus_sc_mult_gf2 => gf1_plus_sc_mult_gf2_cgf
      !! Generic type bound procedure for storing the result of adding a
      !! second grid function with a scalar multiplying a third grid function
      !! in a grid function.
      procedure, non_overridable :: sc_mult_gf1_plus_sc_mult_gf2 => sc_mult_gf1_plus_sc_mult_gf2_cgf
      !! Generic type bound procedure for storing the result of adding a
      !! scalar multiplying a second grid function with another scalar
      !! multiplying a third grid function in a grid function.
      final :: deallocate_cgf
      !! The finalizer.
  end type cgf

cgf Derived Type

Contents

Source Code

type, public, extends(gf) :: cgf

Inherits

Inherited by

Contents

Source Code

Components

Constructor

public interface cgf

public interface init_cgf()

Arguments

Finalization Procedures

final :: deallocate_cgf

public interface deallocate_cgf()

Arguments

Type-Bound Procedures

procedure, public, non_overridable :: output => output_cgf

interface

public module subroutine output_cgf(this, coord) Implementation →

Arguments

procedure, public, non_overridable :: copy => copy_cgf

interface

public module subroutine copy_cgf(this, gf) Implementation →

Arguments

procedure, public, non_overridable :: zero => zero_cgf

interface

public module subroutine zero_cgf(this) Implementation →

Arguments

procedure, public, non_overridable :: mult_sc => mult_sc_cgf

interface

public module subroutine mult_sc_cgf(this, scalar) Implementation →

Arguments

procedure, public, non_overridable :: sc_mult_gf => sc_mult_gf_cgf

interface

public module subroutine sc_mult_gf_cgf(this, scalar, gf) Implementation →

Arguments

procedure, public, non_overridable :: add_gf => add_gf_cgf

interface

public module subroutine add_gf_cgf(this, gf) Implementation →

Arguments

procedure, public, non_overridable :: add_sc_mult_gf => add_sc_mult_gf_cgf

interface

public module subroutine add_sc_mult_gf_cgf(this, scalar, gf) Implementation →

Arguments

procedure, public, non_overridable :: mult_sc_add_sc_mult_gf => mult_sc_add_sc_mult_gf_cgf

interface

public module subroutine mult_sc_add_sc_mult_gf_cgf(this, scalar1, scalar2, gf) Implementation →

Arguments

procedure, public, non_overridable :: gf1_plus_sc_mult_gf2 => gf1_plus_sc_mult_gf2_cgf

interface

public module subroutine gf1_plus_sc_mult_gf2_cgf(this, gf1, scalar, gf2) Implementation →

Arguments

procedure, public, non_overridable :: sc_mult_gf1_plus_sc_mult_gf2 => sc_mult_gf1_plus_sc_mult_gf2_cgf

interface

public module subroutine sc_mult_gf1_plus_sc_mult_gf2_cgf(this, gf1, scalar1, gf2, scalar2) Implementation →

Arguments

Source Code

public module subroutine output_cgf(this, coord)

public module subroutine copy_cgf(this, gf)

public module subroutine zero_cgf(this)

public module subroutine mult_sc_cgf(this, scalar)

public module subroutine sc_mult_gf_cgf(this, scalar, gf)

public module subroutine add_gf_cgf(this, gf)

public module subroutine add_sc_mult_gf_cgf(this, scalar, gf)

public module subroutine mult_sc_add_sc_mult_gf_cgf(this, scalar1, scalar2, gf)

public module subroutine gf1_plus_sc_mult_gf2_cgf(this, gf1, scalar, gf2)

public module subroutine sc_mult_gf1_plus_sc_mult_gf2_cgf(this, gf1, scalar1, gf2, scalar2)