uniform_gradient_field_mod

Provides an extension of the uniform field type which also appears to have a uniform gradient. This was written to allow some of the same code used when solving the plume in a Runge-Kutta solver, where I pass in uniform fields rather than ones using a Chebyshev grid.

Uses

- iso_fortran_env
- utils_mod
- factual_mod
Help
Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Used by

Help
Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.

Interfaces

uniform_gradient_field

Derived Types

uniform_gradient_field

Functions

constructor uniform_gradient_d_dx uniform_gradient_gradient uniform_gradient_is_equal

Subroutines

uniform_gradient_assign

Interfaces

public interface uniform_gradient_field

private function constructor(val, grad) result(this)

Author: Chris MacMackin
Date: July 2017

Creates a new scalar field with a uniform value across all of space but a non-zero gradient.

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=r8),	intent(in)			::	val	The value of the field
real(kind=r8),	intent(in),		dimension(:)	::	grad	An array in which the `i`th element contains the gradient in the _i_th direction. Directions corresponding to values of `i` greater than the size of the array are taken to have a gradient of zero.

Return Value type(uniform_gradient_field)

A scalar field initated based on teh arguments of this function.

Derived Types

type, public, extends(uniform_scalar_field) :: uniform_gradient_field

A type of uniform field which also has a uniform gradient. Of course, this is impossible in practice, but it can be useful for tricking certain routines into working properly. Ideally a whole new derived type would be created which just holds the value and gradient at a single point, but the emphasis is on getting something quickly. Note that the gradient is not propagated across operations--the result of all overloaded operators is just a normal uniform field with no gradient.

Components

Type	Visibility	Attributes		Name		Initial
real(kind=r8),	public,	dimension(:), allocatable	::	grad			The values of the gradient in each direction.

Constructor

private function constructor(val, grad)	Creates a new scalar field with a uniform value across all of space but a non-zero gradient.

Type-Bound Procedures

procedure, public :: d_dx => uniform_gradient_d_dx	$\frac{\partial^n}{\partial x_i^n}({\rm field})$
procedure, private :: gradient => uniform_gradient_gradient	$\nabla {\rm field}$
procedure, private :: is_equal => uniform_gradient_is_equal	Checks fields are equal within a tolerance
procedure, private :: assign_field => uniform_gradient_assign	${\rm field} = {\rm field}$

Functions

private function constructor(val, grad) result(this)

Author: Chris MacMackin
Date: July 2017

Creates a new scalar field with a uniform value across all of space but a non-zero gradient.

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=r8),	intent(in)			::	val	The value of the field
real(kind=r8),	intent(in),		dimension(:)	::	grad	An array in which the `i`th element contains the gradient in the _i_th direction. Directions corresponding to values of `i` greater than the size of the array are taken to have a gradient of zero.

Return Value type(uniform_gradient_field)

A scalar field initated based on teh arguments of this function.

private function uniform_gradient_d_dx(this, dir, order) result(res)

Author: Chris MacMackin
Date: July 2017

$\frac{\partial^{\rm order}}{\partial x_{\rm dir}^{\rm order}}{\rm field}$

Arguments

Type	Intent	Optional		Name
class(uniform_gradient_field),	intent(in)		::	this
integer,	intent(in)		::	dir	Direction in which to differentiate
integer,	intent(in),	optional	::	order	Order of the derivative, default = 1

Return Value class(scalar_field), pointer

private function uniform_gradient_gradient(this) result(res)

Author: Chris MacMackin
Date: July 2017

$\nabla{\rm field}$

Arguments

Type	Intent	Optional	Attributes		Name
class(uniform_gradient_field),	intent(in)			::	this

Return Value class(vector_field), pointer

The result of this operation

private function uniform_gradient_is_equal(this, rhs) result(iseq)

Author: Chris MacMackin
Date: July 2017

Evaluates whether two scalar fields are equal within a tolerance, specified by set_tol.

Arguments

Type	Intent	Optional	Attributes		Name
class(uniform_gradient_field),	intent(in)			::	this
class(scalar_field),	intent(in)			::	rhs

Return Value logical

Subroutines

private impure elemental subroutine uniform_gradient_assign(this, rhs)

Author: Chris MacMackin
Date: July 2017

${\rm field} = {\rm field}$

Arguments

Type	Intent	Optional	Attributes		Name
class(uniform_gradient_field),	intent(inout)			::	this
class(scalar_field),	intent(in)			::	rhs

uniform_gradient_field_mod Module

Contents

Interfaces

Derived Types

Functions

Subroutines

Uses

Used by

Contents

Interfaces

Derived Types

Functions

Subroutines

Interfaces

public interface uniform_gradient_field

private function constructor(val, grad) result(this)

Arguments

Return Value type(uniform_gradient_field)

Derived Types

type, public, extends(uniform_scalar_field) :: uniform_gradient_field

Components

Constructor

Type-Bound Procedures

Functions

private function constructor(val, grad) result(this)

Arguments

Return Value type(uniform_gradient_field)

private function uniform_gradient_d_dx(this, dir, order) result(res)

Arguments

Return Value class(scalar_field), pointer

private function uniform_gradient_gradient(this) result(res)

Arguments

Return Value class(vector_field), pointer

private function uniform_gradient_is_equal(this, rhs) result(iseq)

Arguments

Return Value logical

Subroutines

private impure elemental subroutine uniform_gradient_assign(this, rhs)

Arguments